Verify

Verify verification code by ID

Changed on

Checks the supplied code, or the supplied status for a custom-code verification, against the verification identified by ID. The response indicates whether the verification was accepted or rejected.

post/verifications/{verification_id}/actions/verify

Request

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

Path parameters

verification_idstring uuid required
Example:12ade33a-21c0-473b-b055-b3c836e1c292

The identifier of the verification to retrieve.

Request body

codestring

This is the code the user submits for verification.

status'accepted' | 'rejected'

Identifies if the verification code has been accepted or rejected. Only permitted if custom_code was used for the verification.

Example request

{
  "code": "17686",
  "status": "accepted"
}

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