Download OpenAPI specification:Download
Callback events are used to authorize and manage your verification requests and return verification results.
This callback event is a POST request to the specified verification callback URL and is triggered when a new verification request is made from the SDK client or the Verification Request API. This callback event is only triggered when a verification callback URL is specified in your dashboard.
id required | string The ID of the verification request. |
event required | string The type of the event. |
method required | string The verification method. |
required | object (Identity) Specifies the type of endpoint that will be verified and the particular endpoint. |
object The amount of money and currency of the verification request. | |
reference | string Used to pass your own reference in the request for tracking purposes. |
custom | string Can be used to pass custom data in the request. |
acceptLanguage | Array of strings Allows you to set or override if provided in the API request, the SMS verification content language. Only used with the SMS verification method. The content language specified in the API request or in the callback can be overridden by carrier provider specific templates, due to compliance and legal requirements, such as US shortcode requirements (pdf). |
{- "id": "1234567890",
- "event": "VerificationRequestEvent",
- "method": "sms",
- "identity": {
- "type": "number",
- "endpoint": "+11235551234"
}, - "price": {
- "amount": 10.5,
- "currencyId": "USD"
}, - "reference": "string",
- "custom": "string",
- "acceptLanguage": [
- "es-ES"
]
}
{ }
This callback event is a POST request to the specified verification callback URL and triggered when a verification has been completed and the result is known. It's used to report the verification result to the developer's backend application. This callback event is only triggered when the verification callback URL is specified in your dashboard.
{- "id": "1234567890",
- "event": "VerificationResultEvent",
- "method": "sms",
- "identity": {
- "type": "number",
- "endpoint": "+11235551234"
}, - "status": "PENDING",
- "reason": "“Fraud”",
- "reference": "12345",
- "source": "intercept",
- "custom": "string"
}
{ }