Verify

Verify verification code by phone number

Changed on

Submits a verification code for the specified phone number and Verify profile. The response indicates whether the code was accepted or rejected.

post/verifications/by_phone_number/{phone_number}/actions/verify

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/verifications/by_phone_number/{phone_number}/actions/verify
  • Auth: HTTP bearer

Path parameters

phone_numberstring required

+E164 formatted phone number.

Example:+13035551234

The phone number associated with the verification code being verified.

Request body

codestring required

This is the code the user submits for verification.

verify_profile_idstring uuid required

The identifier of the associated Verify profile.

Example request

{
  "code": "17686",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}

Response

Expected verify response to a valid request.

Example response

{
  "data": {
    "phone_number": "+13035551234",
    "response_code": "accepted"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status