Verify

Retrieve verification

Changed on

Returns the verification identified by ID, including its channel, phone number, Verify profile, timeout, and current status.

get/verifications/{verification_id}

Request

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

Path parameters

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

The identifier of the verification to retrieve.

Response

Expected verifications response to a valid request.

Example response

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

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