v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Credentials

Lookup

Retrieve full exposure history for specific email addresses, usernames, or credential hashes.

post/identity/credentials/lookup

Request body

organization_idstring

subjectsstring[]

Email addresses to look up (e.g., user@example.com)

subjects_sha1string[]

SHA1 hashes of email addresses for privacy-preserving lookups

limitinteger

Maximum number of results to return

offsetstring

Pagination token from a previous response's next_offset

Example request

{
  "organization_id": "uhash:a1b2c3d4",
  "subjects": [
    "j.doe@personal-email.com"
  ],
  "subjects_sha1": [
    "05c75cd3c20e234a9195f148489f660d5e8a5b1e"
  ],
  "subjects_login": [
    {
      "login": "j.doe",
      "login_sha1": "7a827725b8a6886f376174a813470783472e3952",
      "domain": "example-corp.com"
    }
  ],
  "filter": {
    "first_downloaded_gte": "2024-01-01T00:00:00Z",
    "latest_downloaded_gte": "2024-01-01T00:00:00Z",
    "exfiltration_date_gte": "2024-01-01T00:00:00Z",
    "breach_properties": {
      "name": "ExampleCorp Breach 2024",
      "date": "2024-03-15T00:00:00Z"
    },
    "dump_properties": {
      "name": "Collection",
      "date": "2019-01-07T00:00:00Z"
    },
    "authorization_technologies": [
      "SAML"
    ],
    "authorization_protocols": [
      "RDP"
    ],
    "malware_families": [
      "RedLine Stealer"
    ]
  },
  "offset": "cD1lMzE5NTQ2OS1hYjYxLTQ1NTgtYjkyOC1iYjE3MWNkM2QyY2U="
}

Response

Success

countinteger required

next_offsetstring