Skip to main content
GET
/
verify_profiles
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const verifyProfiles = await client.verifyProfiles.list();

console.log(verifyProfiles.data);
{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "name": "Test Profile",
      "webhook_url": "http://example.com/webhook",
      "webhook_failover_url": "http://example.com/webhook/failover",
      "record_type": "verification_profile",
      "created_at": "2020-09-14T17:03:32.965812",
      "updated_at": "2020-09-14T17:03:32.965812",
      "sms": {
        "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
        "app_name": "Example Secure App",
        "alpha_sender": "Telnyx",
        "code_length": 6,
        "whitelisted_destinations": [
          "US",
          "CA"
        ],
        "default_verification_timeout_secs": 300
      },
      "call": {
        "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
        "app_name": "Example Secure App",
        "code_length": 6,
        "whitelisted_destinations": [
          "US",
          "CA"
        ],
        "default_verification_timeout_secs": 300
      },
      "flashcall": {
        "default_verification_timeout_secs": 300
      },
      "language": "en-US"
    }
  ],
  "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.

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[name]

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

Expected Verify profile response to a valid request.

A paginated list of Verify profiles

data
VerifyProfileResponse · object[]
required
meta
object
required