Payments
BIN Lookup & Card Insights
The Evervault API provides two endpoints to retrieve card metadata. The Inspect endpoint allows you to retrieve metadata for a tokenized card, while the BIN Lookup endpoint allows you to retrieve metadata for a card BIN number range. The card insights can be used for tasks such as fraud detection and payment routing.
Inspect API for Tokenized Cards
To retrieve metadata for a tokenized card, simply send the tokenized card number to the Inspect API endpoint. The API key and app ID are required to authenticate the request. The API key requires the api:inspect permission.
The Inspect endpoint requires a JSON-formatted string (not a JSON object), so be sure to enclose the tokenized card number in double quotes.
The response includes the card metadata, such as the card BIN, the last four digits, the funding type, and other relevant details.
BIN Lookup API for Plaintext Card Numbers
To retrieve card metadata for a card number, send the card number to the BIN Lookup API endpoint. The response includes the BIN metadata, such as the card brand, the funding type, the country, and other relevant details. You can pass a number that is 6 to 19 digits long. If the number matches a range of BINs, the response only returns metadata that is common to all the BINs in that range. The API key and app ID are required to authenticate the request. The API key requires the binLookup:create permission.
The response includes the card metadata, such as the card brand, the bin type (card or network-token), the funding type, and other relevant details.
Supported card metadata
| Metadata | Description | Inspect | BIN Lookup |
|---|---|---|---|
| Fingerprint | A unique identifier for the tokenized card. This can be used to detect card reuse. | ✅ | |
| BIN | The first 6 or 8 digits of the card number. | ✅ | |
| Last 4 | The last 4 digits of the card number. | ✅ | |
| Brand | The card brand associated with the payment card. | ✅ | ✅ |
| Funding Type | The card funding type specifies the method by which transactions are financed (e.g. debit, credit). | ✅ | ✅ |
| Segment | The card segment indicates the primary market or usage category of the card (e.g. consumer, etc.). | ✅ | ✅ |
| Country | The country where the card was issued. | ✅ | ✅ |
| Currency | The currency of the card. | ✅ | ✅ |
| Issuer | The card issuer. | ✅ | ✅ |