Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
SDK

Initialize sms verification process

post/sdk/{environmentId}/smsVerifications/create

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

phoneCountryCodestring required
phoneNumberstring required
isoCountryCodestring required
captchaTokenstring

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

Example request

{
  "phoneCountryCode": "An example name",
  "phoneNumber": "An example name",
  "isoCountryCode": "US"
}

Response

Successful response, that contains verification UUID.

verificationUUIDstring required
phoneNumberstring required

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

phoneCountryCodestring required

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

isoCountryCodestring required

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

Example response

{
  "verificationUUID": "95b11417-f18f-457f-8804-68e361f9164f",
  "phoneNumber": "9171113333",
  "phoneCountryCode": "1",
  "isoCountryCode": "US"
}