POST
/
phone-service
/
verification
Verification
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/phone-service/verification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumber": "+436501234567",
  "method": "sms",
  "email": "test@test.com"
}'
{
  "referenceId": "0123456789ABCDEF0123456789ABCDEF",
  "status": {
    "code": 3901,
    "description": "Request in progress"
  },
  "recipient": {
    "phoneNumber": "11234567890"
  },
  "method": "sms",
  "state": "CREATED"
}
For a usage description of the Verification Service, please refer to the Verification page.

​
Endpoint

POST /phone-service/verification

​
Swagger

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
method
enum<string>
required

Delivery method to use.

Available options:
sms,
email
Example:

"sms"

​
phoneNumber
string

Recipient's phone number in international format, no spaces or special characters. Required if method = sms.

Example:

"14155550123"

​
email
string<email>

Recipient's email address. Required if method = email.

Example:

"user@example.com"

​
securityFactor
string

Custom numeric OTP (3–10 digits). If omitted, a 6-digit OTP is auto-generated.

Example:

"123456"

​
externalId
string

Customer-defined transaction ID. Max length: 100 characters.

Maximum length: 100
Example:

"verifyRequest123"

​
messageTemplate
object
​
voiceLang
string

Language code for OTP delivery (e.g., 'en-US'). Defaults to English if not provided.

Example:

"en-US"

Response

Successfully initiated verification.

​
referenceId
string
required

Unique 32-character hex string that identifies the verification process.

Example:

"0123456789ABCDEF0123456789ABCDEF"

​
status
object
required
​
state
enum<string>
required

Current state of the verification process.

Available options:
CREATED,
ONGOING,
REJECTED,
FAILED,
VERIFIED,
CANCELED
Example:

"CREATED"

​
method
enum<string>
required

The verification method used.

Available options:
sms,
email
Example:

"sms"

​
recipient
object