Initialize SMS verification process

Initiates the SMS verification process and sends a verification code.

POST /sdk/{environmentId}/smsVerifications/create

Initialize sms verification process

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/smsVerifications/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneCountryCode": "An example name",
  "phoneNumber": "An example name",
  "isoCountryCode": "US",
  "captchaToken": "<string>"
}
'

201

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Sms Verification data

phoneCountryCode · string · required

Maximum string length: 255

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

phoneNumber · string · required

Maximum string length: 255

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

isoCountryCode · string · required

Maximum string length: 4

Pattern: ^[a-zA-Z]{2,4}\d?$

Example:

"US"

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

Successful response, that contains verification UUID.

verificationUUID · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

phoneNumber · string · required

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

Example:

"9171113333"

phoneCountryCode · string · required

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

Example:

"1"

isoCountryCode · string · required

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

Example:

"US"