Retrieving Identity Exposures

Pull past exposures of user identities

The following API endpoint allows you to retrieve historical exposures for a given identity, using your API key. This can be used in complementary fashion with the monitoring APIs to both monitor for new exposures of a given identity, after pulling the past exposures. Note that you will need to have Identity Breach Monitoring added to your subscription before you can call this API.

---

Pull historical exposures for a specific identity

post

Allows you to pull historical exposure details for an individual identity. The identity can include elements such as name, physical address, phone numbers, government IDs, email addresses, credit cards, etc.

Authorizations

Body

The identity to pull exposures for. One of the following sets of fields is required and must be provided or the request will be rejected with a 400:

• firstName, lastName, country, and governmentID
• emails
• creditCards
• cryptocurrencyWallets
• urls
• ip4Addresses
• ip6Addresses

firstNamestringRequired

Legal first name

Example: John

lastNamestringRequired

Legal last name

Example: Doe

countrystringRequired

The ISO 3166-1 alpha 2 country code for the individual

Example: US

address1stringOptional

Physical street address

Example: 1234 Main St

address2stringOptional

Physical address line 2

Example: Suite 100

citystringOptional

Physical address city

Example: New York

provincestringOptional

Physical address province/state (2 letter abbreviation for US states)

Example: NY

postalCodestringOptional

Physical address postal code (5-digit ZIP code in US)

Example: 12345

emailsstring[]Optional

An array of email addresses associated with this identity

Example: [email protected]

creditCardsstring[]Optional

An array of payment card numbers associated with this identity

Example: 4111-1111-1111-1111

cryptocurrencyWalletsstring[]Optional

An array of cryptocurrency wallet addresses

Example: 34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo

urlsstring[]Optional

An array of URLs associated with this identity. The URL scheme must be included and can be http, https, ftp, ftps, smtp or smtps. URLs are partial match from the beginning of the value, so if https://www.enzoic.com/some/page was found in a breach and https://www.enzoic.com was the URL being monitored, this would be considered a match.

Example: https://www.enzoic.com

ip4Addressesstring[]Optional

An array of IPv4 addresses to monitor

Example: 134.88.23.1

ip6Addressesstring[]Optional

An array of IPv6 addresses to monitor

Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

Responses

200

The response body contains the requested results.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "firstName": "John",
  "lastName": "Doe",
  "country": "US",
  "address1": "1234 Main St",
  "address2": "Suite 100",
  "city": "New York",
  "province": "NY",
  "postalCode": 12345,
  "governmentID": {
    "country": "US",
    "value": "123-12-1234"
  },
  "emails": [
    "[email protected]"
  ],
  "phoneNumbers": [
    {
      "country": "text",
      "value": "text"
    }
  ],
  "creditCards": [
    "4111-1111-1111-1111"
  ],
  "cryptocurrencyWallets": [
    "34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo"
  ],
  "urls": [
    "https://www.enzoic.com"
  ],
  "ip4Addresses": [
    "134.88.23.1"
  ],
  "ip6Addresses": [
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ],
  "secondaryMatchItems": [
    {
      "description": "Bank of America Checking Account",
      "value": 90082323215
    }
  ]
}

200

The response body contains the requested results.

{
  "matches": [
    {
      "exposureID": "text",
      "matchedItems": {
        "foundValue": "4111-1111-1111-1111",
        "queriedValue": 4111111111111111
      },
      "rawMatchSource": "Jimmy Dean\n2121 Cherrybrook Dr, Suite 200 Heisenberg, CO 12345\nSSN 232-44-3432\nMobile: [phone]\[email protected]\nVisa 4111111111111111 03/28 444\nBTC Wallet 0xb794f5ea0ba39494ce839613fffba74279579268 (1.0233 balance)\nEIN: 12-3123122\nWells Fargo Checking - Account #900000001\n"
    }
  ]
}