Sign in
Verify

Trigger SMS verification

Starts a verification for the specified phone number and sends its code by SMS using the selected Verify profile. Returns the pending verification record.

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"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.211

  • 1571b0380bd711See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799411See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog