List verifications by phone number

GET 
/verifications/by_phone_number/:phone_number

List verifications by phone number

Path Parameters

phone_number stringrequired

The phone number associated with the verifications to retrieve.

200: Expected verifications response to a valid request.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

id uuid

type VerificationType (string)

Possible values: [sms, call, flashcall]

The possible types of verification.

record_type VerificationRecordType (string)

Possible values: [verification]

The possible verification record types.

phone_number string

+E164 formatted phone number.

verify_profile_id uuid

The identifier of the associated Verify profile.

custom_code stringnullable

Send a self-generated numeric code to the end-user

timeout_secs integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

status VerificationStatus (string)

Possible values: [pending, accepted, invalid, expired, error]

The possible statuses of the verification request.

created_at string

updated_at string

]

meta

object

required

total_pages integer

total_results integer

page_number integer

page_size integer

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

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10015",
      "title": "Invalid sorting value",
      "detail": "The value provided for sorting is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/sort",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/verifications/by_phone_number/:phone_number' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 400

---

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

{
  "errors": [
    {
      "code": "10015",
      "title": "Invalid sorting value",
      "detail": "The value provided for sorting is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/sort",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}