Identity Verification Webhooks

Webhook notifications for Identity Verification. For setup and authentication, see Webhooks.

Path Params
string
required

Our unique identifier for the Identity Verification case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Body Params
string
required

Our unique identifier for the case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0
Validations: uuid format, verificationId exists
Errors: Format is incorrect or doesn’t exist

string

The hash code of the XML file.

Format: MD5 hash
Validation: MD5 hash
Errors: Invalid MD5 hash

string
enum
required

The case status.
Validation: Valid enum value
Errors: Invalid enum value.

Allowed:
string
required
Defaults to NaturalPersons

The type of workflow.
Expected value: Always NaturalPersons
Validation: Expected value
Errors: Must be set to NaturalPersons.

sla
object

Information about the SLA for case processing.

messages
object

Information about the case status.

boolean
required

true: We corrected some data entered by the client after the case has been successfully completed.
false: We didn’t correct any data after the case has been successfully completed.
Validation: true or false value
Errors: Invalid boolean value.

string
required

The timestamp for this notification.

Format: ISO 8601 UTC date and time

Example: 2020-07-10 15:00:00.000
Validation: Valid datetime
Errors: Invalid datetime

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json