Enzoic API - Developer Documentation
Visit our website
  • Enzoic Website
  • Getting Started
    • .NET Quick Start
    • Java Quick Start
    • JavaScript Quick Start
    • Ruby Quick Start
    • PHP Quick Start
    • Go Quick Start
    • Python Quick Start
  • Using the Enzoic API
  • Libraries
  • API reference
    • Passwords API
    • Credentials API
      • Hashed Credentials API
      • Cleartext Credentials API
        • Query Passwords for an Email Address
        • Query Passwords for a Domain
        • Query Passwords for a Partial Hash of an Email Address
      • Test Accounts
    • Exposures API
      • Get Exposures for an Email Address
      • Get Exposures for a Domain
      • Get Exposures for All Email Addresses in a Domain
      • Get Exposures by Date
      • Retrieve Details for an Exposure
    • Breach Monitoring API
      • Breach Monitoring by User
        • Add Breach Alert Subscriptions for Users
        • Remove Breach Alert Subscriptions for Users
        • Query Breach Alert Subscriptions for Users
      • Breach Monitoring by Domain
        • Add Breach Alert Subscriptions for Domains
        • Remove Breach Alert Subscriptions for Domains
        • Query Breach Alert Subscriptions for Domains
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • Identity Breach Monitoring API
      • Monitoring Identities
        • Add Identities to Monitoring
        • Update Monitored Identities
        • Remove an Identity from Monitoring
        • Query Monitored Identities
      • Retrieving Identity Exposures
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • BIN Monitoring API
      • Monitoring BINs
        • Add Bank Identification Numbers to Monitoring
        • Remove Bank Identification Numbers from Monitoring
        • Query Monitored Bank Identification Numbers
      • Retrieving Exposed Payment Cards
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • Payment Card Exposures API
      • Check a Card Number for Compromise
    • Account Status APIs
      • Account Status
      • Account Usage
    • Password Hash Algorithms
    • OpenAPI Specification
    • View OpenAPI Spec in Swagger UI
    • Postman Collection of API Examples
  • Password Strength Meter
    • Quick Start
    • Example
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. BIN Monitoring API

Retrieving Exposed Payment Cards

Query for payment card exposures during a given time period

PreviousQuery Monitored Bank Identification NumbersNextWebhooks

Last updated 10 months ago

Was this helpful?

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
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
GET /v1/bin-exposures HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Accept: */*
200

The response body contains the requested results.

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