Retrieving Exposed Payment Cards

Query for payment card exposures during a given time period

This call allows you to query for payment card numbers that Enzoic has recovered matching one or more of your monitored Bank Identification Numbers (BINs). We recommend using a webhook to receive notifications of new payment card exposures in the most timely manner, but this API call can be used if implementing a webhook is not currently feasible, or if you wish to pull historical data.

---

Retrieve list of recovered payment cards for your monitored BINs

get

Returns a list of exposed payment card numbers for your account's monitored BINs within the specified date range. A maximum of 30 days of data can be returned in a single call.

Authorizations

enzoic_auth

AuthorizationstringRequired

The Enzoic API uses a basic auth scheme where the username is your API key and the password is your API secret.
See https://docs.enzoic.com/enzoic-api-developer-documentation/using-the-enzoic-api#api-authentication for more details.

Query parameters

startDatestringOptional

Specifies a start date/time in ISO8601 format (e.g. 2023-06-01T00:00:00Z) to return results for. A maximum of 30 days of data can be returned in a single call.

Example: 2023-06-01

endDatestringOptional

Specifies an end date/time in ISO8601 format (e.g. 2023-06-01T00:00:00Z) to return results for. A maximum of 30 days of data can be returned in a single call.

Example: 2023-06-30

includeRawMatchSourceintegerOptional

If this parameter is specified and non-zero, the results will include the raw match source inline, along with the exposure IDs, showing a snippet of text from the breach source where the card number was found.
NOTE: Including this parameter for large result sets can be very slow and may timeout.

Default: 0Example: 1

Responses

200

The response body contains the requested results.

application/json

get

/bin-exposures

HTTPcURLJavaScriptPython

GET /v1/bin-exposures HTTP/1.1
Host: api.enzoic.com
Authorization: Basic username:password
Accept: */*

200

The response body contains the requested results.

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