Skip to main content

Trigger SMS verification

POST 
/verifications/sms

Trigger SMS verification

Request

Body

required

    phone_number stringrequired

    +E164 formatted phone number.

    verify_profile_id uuidrequired

    The identifier of the associated Verify profile.

    custom_code stringnullable

    Send a self-generated numeric code to the end-user

    timeout_secs integer

    The number of seconds the verification code is valid for.

Responses

200: Expected verifications response to a valid request.

400: Bad Request

Request samples


curl -L 'https://api.telnyx.com/v2/verifications/sms' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"phone_number": "+13035551234",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"custom_code": "43612",
"timeout_secs": 300
}'

Response samples


{
"data": {
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"type": "sms",
"record_type": "verification",
"phone_number": "+13035551234",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"custom_code": "43612",
"timeout_secs": 300,
"status": "accepted",
"created_at": "2020-09-14T17:03:32.965812",
"updated_at": "2020-09-14T17:03:32.965812"
}
}