Trigger SMS verification

POST 
/verifications/sms

Trigger SMS verification

Request

application/json

Body

required

phone_number stringrequired

+E164 formatted phone number.

verify_profile_id uuidrequired

The identifier of the associated Verify profile.

timeout_secs integer

The number of seconds the verification code is valid for.

Responses

200: Expected verifications response to a valid request.

application/json

• Schema
• Example (from schema)

Schema

data

object

required

id uuid

type VerificationType (string)

Possible values: [sms, call, flashcall]

The possible types of verification.

record_type VerificationRecordType (string)

Possible values: [verification]

The possible verification record types.

phone_number string

+E164 formatted phone number.

verify_profile_id uuid

The identifier of the associated Verify profile.

timeout_secs integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

status VerificationStatus (string)

Possible values: [pending, accepted, invalid, expired, error]

The possible statuses of the verification request.

created_at string

updated_at string

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

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10015",
      "title": "Invalid sorting value",
      "detail": "The value provided for sorting is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/sort",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Loading...