Skip to main content
POST
IP → Hashed Email

Authorizations

X-Api-Key
string
header
required

Per-account API key. Also accepted as Api-Key or Authorization: Bearer <key>.

Body

application/json
ip_address
string
required

IPv4 or IPv6 address of the visitor.

Example:

"203.0.113.42"

user_agent
string

Visitor's browser User-Agent. Optional; improves match confidence when provided.

Example:

"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"

include_sha256
boolean
default:false

Also include each match's SHA-256 hashed email as sha256.

Response

Matches found (1 credit charged)

results
object[]
required

Up to 3 hashed-email matches, ordered by descending score.