Skip to main content
POST
Check identifiers
Check up to five hashed emails for one user against the Shared Registry. Hash each email with the published rules first. To act on the result, see Check a sign-up.

Authorizations

Authorization
string
header
required

API key from the Omnifence dashboard

Body

application/json
identifiers
object[]
required
Required array length: 1 - 5 elements
context
enum<string>
required

Why you are checking: at account creation, at login, or as a periodic re-check of existing accounts.

Available options:
signup,
login,
periodic

Response

200 - application/json

Default Response

match
boolean
required
signals
object[]
required
normalisation_version
integer
required