Verification Request Event

The Verification Request Event is triggered when a new verification request is initiated from the SDK client or through the Verification Request API.

This callback event is sent as an HTTP POST request to the verification callback URL configured in the Sinch SMV Platform.

The callback is triggered only when a verification callback URL is configured in the dashboard.

Sample Request:

{
  "id": "XXXXXXXXXXXXXXXXXXXX",
  "event": "VerificationRequestEvent",
  "method": "seamless",
  "identity": {
    "type": "number",
    "endpoint": "+1XXXXXXXXXX"
  },
  "reference": "string",
  "custom": "string",
  "price": {
    "currencyId": "USD",
    "amount": 0.0127
  }
}

Parameter	Description	JSON Type	Required
id	The unique ID of the verification request.	String	Yes
event	Event received onto verification request. Example: "VerificationRequestEvent"	string	Yes
reference	Your custom reference for tracking purposes.The reference can be used to check the status of verifications, like with ID or identity.	string	No
custom	Optional custom data passed through the verification process.	string	No
identity	Specifies the type of endpoint that will be verified	object	yes
type	Currently only number type is supported.	String	yes
endpoint	E.164 phone number (example: +46700000000).	string	Yes
method	The method of the verification request.	string	yes
price	Prices associated with this verification.This property will appear in the body of the response with a delay. It will become visible only when the verification status is other than PENDING.	object	yes
currencyId		string	yes
amount		string	yes

Sample Response:

{
   "action": "allow"
}

{
   "action": "deny"
}

Enum Value	Description
allow	Verification allowed.
deny	Verification denied.