v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Verify

Trigger SMS verification

post/verifications/sms

Request body

custom_codestring nullable

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

phone_numberstring required

+E164 formatted phone number.

timeout_secsinteger

The number of seconds the verification code is valid for.

verify_profile_idstring uuid required

The identifier of the associated Verify profile.

Example request

{
  "custom_code": "43612",
  "phone_number": "+13035551234",
  "timeout_secs": 300,
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}

Response

Expected verifications response to a valid request.

Example response

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