Skip to main content
WEBHOOK
verificationSuccess
{
  "inviteId": "<string>",
  "customId": "<string>",
  "timestamp": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

This webhook message contains information about a successfully completed verification session. It will be submitted to your endpoint as a POST request.

​
inviteId
string

The unique ID for the invite that was successfully completed.

​
customId
string | null

The ID that was provided to us by you when creating an invite.

​
timestamp
integer<int32>

Unix timestamp in seconds for when the verification was completed. This can be used for idempotency.

Response

200

Return a 200 status to us indicating that the data was received successfully. This should be done as quickly as possible.