Initialize sms verification process

Path Parameters

environmentId

string

required

ID of the environment

Body

application/json

phoneCountryCode

string

required

phoneNumber

string

required

isoCountryCode

string

required

captchaToken

string

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

Response

201 - application/json

verificationUUID

string

required

phoneNumber

string

required

This field contains the phone number in the country. This could also contain the area code within a country.

phoneCountryCode

string

required

This field contains the phone international country code. See https://countrycode.org/

isoCountryCode

string

required

ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes