This page describes the SMS Phone Confirmation endpoints available using the POST method.
Related SMS Phone Confirmation documentation:
- SMS Phone Confirmation introduction
- SMS Phone Confirmation GET request
- SMS Phone Confirmation response
- SMS Confirmation Swagger documentation
SMS Phone Confirmation POST request
SMS Phone Confirmation - GDPR_MSG
Endpoint:
https://{SERVER_ADDRESS}/GDPR_MSG/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| Phone | {PHONE} |
Phone number in international format. | Mandatory |
| Duration | {DURATION} |
Validity duration of the SMS code. | Optional |
| Custom_sms | {CUSTOM_SMS_CONTENT} |
Custom SMS content. Limited to 125 characters. The verification code is automatically appended. | Mandatory |
| Phonecom | {VALUE_PHONECOM} |
1 or 0. Indicates whether phone communication consent was selected. |
Optional |
{VALUE_EMAIL} |
1 or 0. Indicates whether email communication consent was selected. |
Optional | |
| Post | {VALUE_POST} |
1 or 0. Indicates whether postal communication consent was selected. |
Optional |
| Sms | {VALUE_SMS} |
1 or 0. Indicates whether SMS communication consent was selected. |
Optional |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Company | {COMPANY_NAME} |
Company name used as the SMS sender. Minimum 3 characters and maximum 11 characters. | Mandatory |
Optional multi-contact consent parameters
- SMS2 / SMS3 / SMS4 / SMS5: consent for secondary phone numbers.
- PHONE2 / PHONE3 / PHONE4 / PHONE5: consent for secondary voice numbers.
- EMAIL2 / EMAIL3 / EMAIL4 / EMAIL5: consent for secondary email addresses.
- POST2 / POST3 / POST4 / POST5: consent for secondary postal addresses.
SMS Phone Confirmation - GDPR_VERIF
Endpoint:
https://{SERVER_ADDRESS}/GDPR_VERIF/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Phone | {PHONE} |
Phone number in international format. | Mandatory |
| Token | {SMS_TOKEN} |
Identifier returned by the GDPR_MSG request. |
Mandatory |
| Pin | {CODE_PIN} |
6-digit verification code received by SMS. | Mandatory |
Related to