Verify ownership of phone numbers

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.

POST /phone_numbers/actions/verify_ownership

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.phoneNumbers.actions.verifyOwnership({
  phone_numbers: ['[phone]'],
});

console.log(response.data);

200

{
  "data": {
    "found": [
      {
        "number_val_e164": "[phone]",
        "id": "1293384261075731499"
      }
    ],
    "not_found": [
      "[phone]"
    ],
    "record_type": "number_ownership_verification"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

phone_numbers · string[] · required

Array of phone numbers to verify ownership for

Required array length: 1 - 1000 elements

Phone number in E.164 format

Response

200

application/json

Phone number ownership verification completed.

data · object

Show child attributes