Skip to main content
Get Face Match Session

Authorizations

x-api-key
string
header
required

API key authentication

Query Parameters

account_id
string

Your identifier for the user's account. If provided, the session is linked to the account automatically when it completes, enabling multi-accounting detection and account-level features (lists, rules) on the verify response. Must be a non-empty string. See Account ID for more information.

referring_session_id
string<uuid>

ID of a referring session, if applicable

simulate
string

See Simulate Face Match for more information

Response

Session created successfully

request_id
string<uuid>
required

Unique identifier for the request

session_id
string<uuid>
required

Unique identifier for the session