Default

Get attributes of a card PAN or a BIN.

post

Authorizations

OAuth2

Body

application/json

numberstringOptional

One of either a bin, a full credit card PAN. If the number has a length equal to 6 - it is treated as a raw bin. If the number length than 6 then the api will assumes it is a real PAN value and tries to find the card attributes associated with that PAN. A luhn valid PAN is required if length longer than 11.

Example: 4111-1111-1111-1111Pattern: (^(\d[\s-]?){6,19}$|tok_.+)

Responses

200

OK

application/json

400

Bad Request

application/json

401

Not authorized to make this request

422

We could not discern a bin from the input provided. Check input value to ensure a valid bin or valid cc number is entered.

500

Internal VGS error

post

HTTPcURLJavaScriptPython

POST /attributes/attributes HTTP/1.1
Host: card-enrichment-api.live.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "number": "4111-1111-1111-1111"
}

{
  "bin": 4111111,
  "brand": "Visa",
  "issuing_organization": "J.P. Morgan",
  "card_type": "DEBIT",
  "card_category": "PREPAID",
  "issuing_country_name": "United Kingdom",
  "issuing_country_code": "USA",
  "maximum_pan_length": 16,
  "card_commercial_type": "PERSONAL",
  "regulation_status": "UNREGULATED",
  "version": 20240105,
  "prepaid_type": "RELOADABLE",
  "cobadged_brands": "BANCONTACT"
}