List verifications by phone number

GET

verifications

by_phone_number

{phone_number}

JavaScript

import Telnyx from 'telnyx';

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

const byPhoneNumbers = await client.verifications.byPhoneNumber.list('+13035551234');

console.log(byPhoneNumbers.data);

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

Authorizations

Authorization

string

header

required

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

Path Parameters

phone_number

string

required

The phone number associated with the verifications to retrieve. +E164 formatted phone number.

Example:

"+13035551234"

Response

Expected verifications response to a valid request.

data

Verification · object[]

required

Show child attributes

meta

object

required

Show child attributes

Verify verification code by ID

Verify verification code by phone number

⌘I

JavaScript

import Telnyx from 'telnyx';

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

const byPhoneNumbers = await client.verifications.byPhoneNumber.list('+13035551234');

console.log(byPhoneNumbers.data);

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