<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Verify - JavaScript

Installation

npm install [email protected]

Setup

import Telnyx from 'telnyx';

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

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

Lookup phone number data

Returns information about the provided phone number.

GET /numberlookup/{phonenumber}

const numberLookup = await client.numberLookup.retrieve('+18665552368');

console.log(numberLookup.data);

Returns: callername (object), carrier (object), countrycode (string), fraud (string | null), nationalformat (string), phonenumber (string), portability (object), record_type (string)

List verifications by phone number

GET /verifications/byphonenumber/{phone_number}

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

console.log(byPhoneNumbers.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Verify verification code by phone number

POST /verifications/byphonenumber/{phonenumber}/actions/verify — Required: code, verifyprofile_id

const verifyVerificationCodeResponse = await client.verifications.byPhoneNumber.actions.verify(
  '+13035551234',
  { code: '17686', verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292' },
);

console.log(verifyVerificationCodeResponse.data);

Returns: phonenumber (string), responsecode (enum: accepted, rejected)

Trigger Call verification

POST /verifications/call — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), extension (string | null), timeoutsecs (integer)

const createVerificationResponse = await client.verifications.triggerCall({
  phone_number: '+13035551234',
  verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});

console.log(createVerificationResponse.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger Flash call verification

POST /verifications/flashcall — Required: phonenumber, verifyprofile_id

Optional: timeout_secs (integer)

const createVerificationResponse = await client.verifications.triggerFlashcall({
  phone_number: '+13035551234',
  verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});

console.log(createVerificationResponse.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger SMS verification

POST /verifications/sms — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), timeoutsecs (integer)

const createVerificationResponse = await client.verifications.triggerSMS({
  phone_number: '+13035551234',
  verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});

console.log(createVerificationResponse.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger WhatsApp verification

POST /verifications/whatsapp — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), timeoutsecs (integer)

const createVerificationResponse = await client.verifications.triggerWhatsappVerification({
  phone_number: '+13035551234',
  verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});

console.log(createVerificationResponse.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Retrieve verification

GET /verifications/{verification_id}

const verification = await client.verifications.retrieve('12ade33a-21c0-473b-b055-b3c836e1c292');

console.log(verification.data);

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Verify verification code by ID

POST /verifications/{verification_id}/actions/verify

Optional: code (string), status (enum: accepted, rejected)

const verifyVerificationCodeResponse = await client.verifications.actions.verify(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
);

console.log(verifyVerificationCodeResponse.data);

Returns: phonenumber (string), responsecode (enum: accepted, rejected)

List all Verify profiles

Gets a paginated list of Verify profiles.

GET /verify_profiles

// Automatically fetches more pages as needed.
for await (const verifyProfile of client.verifyProfiles.list()) {
  console.log(verifyProfile.id);
}

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Create a Verify profile

Creates a new Verify profile to associate verifications with.

POST /verify_profiles — Required: name

Optional: call (object), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), language (string), sms (object), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

const verifyProfileData = await client.verifyProfiles.create({ name: 'Test Profile' });

console.log(verifyProfileData.data);

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Retrieve Verify profile message templates

List all Verify profile message templates.

GET /verify_profiles/templates

const response = await client.verifyProfiles.retrieveTemplates();

console.log(response.data);

Returns: id (uuid), text (string)

Create message template

Create a new Verify profile message template.

POST /verify_profiles/templates — Required: text

const messageTemplate = await client.verifyProfiles.createTemplate({
  text: 'Your {{app_name}} verification code is: {{code}}.',
});

console.log(messageTemplate.data);

Returns: id (uuid), text (string)

Update message template

Update an existing Verify profile message template.

PATCH /verifyprofiles/templates/{templateid} — Required: text

const messageTemplate = await client.verifyProfiles.updateTemplate(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
  { text: 'Your {{app_name}} verification code is: {{code}}.' },
);

console.log(messageTemplate.data);

Returns: id (uuid), text (string)

Retrieve Verify profile

Gets a single Verify profile.

GET /verifyprofiles/{verifyprofile_id}

const verifyProfileData = await client.verifyProfiles.retrieve(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
);

console.log(verifyProfileData.data);

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Update Verify profile

PATCH /verifyprofiles/{verifyprofile_id}

Optional: call (object), dailyspendlimit (number), dailyspendlimitenabled (boolean), language (string), name (string), sms (object), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

const verifyProfileData = await client.verifyProfiles.update(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
);

console.log(verifyProfileData.data);

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Delete Verify profile

DELETE /verifyprofiles/{verifyprofile_id}

const verifyProfileData = await client.verifyProfiles.delete(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
);

console.log(verifyProfileData.data);

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)