The Verify API enables you to generate, send, and verify OTP codes for the SMS channel.
After you create a channel for your brand, you can list its templates later.
Endpoint and Headers
This API key is sensitive and should only be implemented on the backend. Using it on the frontend or mobile SDK may pose security risks.
Visit our Postman collection to test this request.
Headers
| Header | Sample Value | Description |
|---|---|---|
| X-INS-AUTH-KEY | 1a2b3c4d5e6f | This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. |
| Content-Type | application/json | This header specifies the media type of the resource. |
Sample Request
Every request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
Make sure to replace the sample values in the request header(s) and body where required before sending your request.
Below is a sample request to list all verification templates available in your account.
curl --location 'verify.useinsider.com/v1/template/list' \
--header 'Content-Type: application/json' \
--header 'x-ins-auth-key: 1a2b3c4d5e6f'Sample Responses
200 OK
This response indicates that your request was successfully completed.
{
"templates": {
"sms": [
{
"locale": "de",
"text": "Ihr {brandName} Bestätigungscode lautet: {code}"
},
{
"locale": "en",
"text": "Your {brandName} verification code is: {code}"
},
{
"locale": "es",
"text": "Su código de verificación de {brandName} es: {code}"
},
{
"locale": "fr",
"text": "Votre code de vérification {brandName} est: {code}"
},
{
"locale": "it",
"text": "Il tuo codice di verifica {brandName} è: {code}"
},
{
"locale": "ja",
"text": "あなたの{brandName}確認コードは: {code}です"
},
{
"locale": "nl",
"text": "Uw {brandName} verificatiecode is: {code}"
},
{
"locale": "pt",
"text": "Seu código de verificação {brandName} é: {code}"
},
{
"locale": "ru",
"text": "Ваш проверочный код {brandName}: {code}"
},
{
"locale": "tr",
"text": "{brandName} doğrulama kodunuz: {code}"
}
]
}
}401 Unauthorized
{
"errors": [
{
"message": "unauthorized"
}
]
}429 Too Many Requests
{
"errors": [
{
"message": "rate limit exceeded"
}
]
}Limitations
- All functions must be executed with a simple HTTPS GET request.
- The API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will be returned in the response.
- The rate limit is 25 requests per minute.
The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.