Skip to main content

Verify ownership of phone numbers

POST 
/phone_numbers/actions/verify_ownership

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.

Request ​

Body

required

    phone_numbers string[]required

    Possible values: >= 1, <= 1000

    Array of phone numbers to verify ownership for

Responses ​

200: Phone number ownership verification completed.

Schema

    data

    object

    found

    object[]

    The list of phone numbers which you own and are in an editable state

  • Array [

    • number_val_e164 string

    The phone number in E.164 format

    id int64

    Identifies the resource.

  • ]

    • The list of phone numbers which you own and are in an editable state

    not_found string[]

    Phone numbers that are not found in the account

    record_type string

    Identifies the type of the resource.

422: Unprocessable Entity

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.

  • ]

default: Unexpected error

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.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/phone_numbers/actions/verify_ownership' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone_numbers": [
    "+15551234567"
  ]
}'

Response samples

{
  "data": {
    "found": [
      {
        "number_val_e164": "+15551234567",
        "id": "1293384261075731499"
      }
    ],
    "not_found": [
      "+15551234568"
    ],
    "record_type": "number_ownership_verification"
  }
}