Verify API
The verification API allows you to verify if a user currently has access to a given phone number or email address, by sending them an OTP and asking them to verify the code that was sent to them.
This can be achieved by using the following API endpoints below.
Sending a Verification
In order to send a message you must have an active channel and perform an HTTP request to the following endpoint with a valid access key.
Creates a new verification message
The ID of the workspace
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
The maximum number of attempts to verify the user. [Default: 3]
3
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
600
The length of the verification code. [Default: 6]
6
POST /workspaces/{workspaceId}/verify HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"timeout": 600,
"codeLength": 6,
"steps": [
null
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
Here is an example of a basic verify request body for SMS
{
"identifier": {
"phonenumber": "+31623456789"
},
"steps": [
{
"channelId": "SMS_CHANNEL_UUID"
}
]
}
Steps
You can use Steps to implement a failover strategy between different channels. The minimum amount of steps is one. Calling the failover endpoint will cause it to move to the next step.
{
"identifier": {
"phonenumber": "+31623456789",
"emailaddress": "[email protected]"
},
"locale": "en-US",
"maxAttempts": 3,
"timeout": 300,
"codeLength": 6,
"steps": [
{
"channelId": "CHANNEL_UUID"
},
{
"channelId": "FAILOVER_CHANNEL_UUID"
}
]
}
Templates
Verify supports using templates for some channels. The following is an example of using a channel with a template.
{
"identifier": {
"phonenumber": "+31623456789",
},
"steps": [
{
"channelId": "CHANNEL_UUID",
"template": {
"projectId": "TEMPLATE_UUID",
"version": "TEMPLATE_VERSION_UUID|latest",
"locale": "en"
}
}
]
}
SMS Templates
SMS does not support templates. For SMS, the body is generated by the verify API. You can however change the language by setting the locale of the verification. Supported languages include:
Afrikaans
Arabic
German
English
Spanish
French
Italian
Dutch
Polish
Portuguese
Russian
Turkish
Email Templates
For emails, templates work just as you would expect via the channels API, with the addition of a variable for the Verify OTP Code.
When setting up a template for Email, select {}
-> Verify
-> OTP
from the list of variables
WhatsApp Templates
Templates for WhatsApp channels are required. In order to send an OTP message to a WhatsApp channel, you need to have an Authentication Template set up.
Verifying the code
Once you have received a code from one of your users you will have to confirm if the code is valid.
Verifies a code of a verification message
The ID of the workspace
The ID for a verification
POST /workspaces/{workspaceId}/verify/{verificationId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"code": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
Resend a code for a specific verification step
Using the following endpoint, you can also resend a message for a given verification step.
By not setting a value for stepIndex
, it will default to the currently active step.
Attempt resending a verification code for a given step
The ID of the workspace
The ID for a verification
The index of the step to use.
null
POST /workspaces/{workspaceId}/verify/{verificationId}/resend HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"stepIndex": 1
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
Failover to next step
You can failover to another verification step by calling the following endpoint.
By not setting a value for stepIndex
, it will default to the next step in the array.
Failover to the next step of the verification process
The ID of the workspace
The ID for a verification
The index of the step to use.
null
POST /workspaces/{workspaceId}/verify/{verificationId}/failover HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"stepIndex": 1
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
Retrieving Verifications
Retrieving a list of Verifications
List all verifications for this workspace
The ID of the workspace
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
Start date for the query
End date for the query
GET /workspaces/{workspaceId}/verify HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"nextPageToken": "text",
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
]
}
Retrieving a single Verification
Get a verification message
The ID of the workspace
The ID for a verification
GET /workspaces/{workspaceId}/verify/{verificationId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": {
"phonenumber": "text",
"emailaddress": "text"
},
"locale": "text",
"maxAttempts": 3,
"failedAttempts": 1,
"timeout": 600,
"codeLength": 6,
"status": "accepted",
"currentStepIndex": 1,
"steps": [
{
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"navigatorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"template": {
"name": "text",
"projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
"locale": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"shortLinks": {
"enabled": true,
"domain": "text"
},
"variables": {
"default": "text",
"ANY_ADDITIONAL_PROPERTY": "text"
},
"utmParameters": [
{
"key": "text",
"value": "text"
}
],
"parameters": [
{
"type": "string",
"key": "text",
"value": "text"
}
],
"settings": {
"useMmLite": true
}
},
"status": "unused",
"attempts": [
{
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"status": "prepared",
"verified": true,
"sentAt": "2025-07-01T22:34:58.956Z",
"verifiedAt": "2025-07-01T22:34:58.956Z"
}
]
}
],
"createdAt": "2025-07-01T22:34:58.956Z",
"updatedAt": "2025-07-01T22:34:58.956Z",
"expiresAt": "2025-07-01T22:34:58.956Z"
}
Last updated
Was this helpful?