Verify

List verifications by phone number

Changed on

Returns a paginated list of verifications associated with the specified phone number.

get/verifications/by_phone_number/{phone_number}

Request

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

Path parameters

phone_numberstring required

+E164 formatted phone number.

Example:+13035551234

The phone number associated with the verifications 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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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