Skip to navigation
Identity verification APIFace Match

List face checks

Returns the face check history for your organisation in the environment of the key, newest first. Checks run from the dashboard appear here too. Deleted checks are left out.

Error codes

errorStatusMeaning
invalid_input400A filter was not text, a date was invalid, or from is after to.
secret_key_required403A publishable key was used. This endpoint accepts secret keys only.
environment_mismatch403The key belongs to an environment this deployment does not serve.
ip_not_allowed403The key has an IP allowlist and the calling address is not on it.
organization_suspended403The organisation is suspended. The response carries reason and suspendedAt.
business_not_approved403A live key was used before the business was approved for production.

A missing or unknown key answers 401, where error is a short sentence rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Query parameters

verdictenumOptional
Only checks with this verdict. An unrecognised value is ignored.
Allowed values:
fromstringOptional
Only records created at or after this ISO date or timestamp.
tostringOptional
Only records created at or before this ISO date or timestamp.
pageintegerOptional>=1Defaults to 1
The page to return, starting at 1.
pageSizeintegerOptional1-100Defaults to 25
Records per page, at most 100.

Response

One page of face checks.
faceCheckslist of objects
The checks on this page, newest first.
totalinteger
How many records match the filters across every page.
pageinteger
The page that was returned.
pageSizeinteger
The page size that was applied.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error