Check a Card Number for Compromise

Retrieve a list of recovered payment card numbers

post

Returns a list of compromised payment card numbers matching a partial card number provided to the call. The partialCardNumber field in the body should contain the first 8 digits of the card number being checked.

This call uses a k-anonymity algorithm to ensure that the complete card number being checked is not sent to the server in the clear. All compromised payment card numbers matching having a match on the first 8 digits will be returned in the cardsFound response, allowing the caller to then locally compare to determine if the full payment card number being checked is in the Enzoic database of compromised card numbers.

Authorizations

Body

partialCardNumberstringRequired

The first 8 digits of the card number being checked.

Example: 40112322

includeRawMatchSourcebooleanOptional

If this parameter is specified and true, the results will include the raw match source inline, along with the exposure IDs. The raw match source will be the snippet of text from the breach source where the card number was found, providing additional context into what else was exposed (e.g. name, CVV, expiration date, etc.).

NOTE: Including this parameter will increase the size and significantly slow the response. Do not specify this parameter unless you actually need the original source text.

Example: true

Responses

200

The response body contains the requested results.

application/json

post

HTTPcURLJavaScriptPython

POST /v1/payment-card-exposures HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "partialCardNumber": 40112322,
  "includeRawMatchSource": true
}

200

The response body contains the requested results.

{
  "cardsFound": [
    {
      "cardNumber": "text",
      "exposures": [
        {
          "exposureID": "5f483321b7496d0008ae3073"
        }
      ],
      "rawMatchSource": "Jane Doe 4242424242424242 08/28 123"
    }
  ]
}