Skip to main content
WEBHOOK
facialAuthentication
{
  "token": "<string>",
  "type": "ENROLLMENT",
  "method": "ACTIVE_LIVENESS",
  "facePhoto": "<string>",
  "ipAddress": "<string>",
  "failReason": "<string>",
  "riskTags": [
    "UNTRUSTED_ENVIRONMENT"
  ]
}

Headers

Idenfy-Event-Type
enum<string>
required
Available options:
FACIAL_AUTHENTICATION
Idenfy-Signature
string

Webhook signature

Body

application/json
token
string

Token string used for authentication.

Maximum string length: 40
type
enum<string>
Available options:
ENROLLMENT,
AUTHENTICATION
method
enum<string>
Available options:
ACTIVE_LIVENESS,
FACE_MATCHING
facePhoto
string<uri> | null
ipAddress
string | null
failReason
string | null
Maximum string length: 255
riskTags
enum<string>[] | null
Available options:
UNTRUSTED_ENVIRONMENT

Response

200

Return a 200 status to indicate that the data was received successfully.