Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const verifyProfileData = await client.verifyProfiles.create({ name: 'Test Profile' }); console.log(verifyProfileData.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" } }

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

Example:

"Test Profile"

webhook_url

string

Example:

"http://example.com/webhook"

webhook_failover_url

string

Example:

"http://example.com/webhook/failover"

sms

CreateVerifyProfileSMSRequest · object

Show child attributes

sms.whitelisted_destinations

string[]

required

Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code

Example:

["US", "CA"]

sms.messaging_template_id

string<uuid>

The message template identifier selected from /verify_profiles/templates

Example:

"0abb5b4f-459f-445a-bfcd-488998b7572d"

sms.app_name

string

The name that identifies the application requesting 2fa in the verification message.

Example:

"Example Secure App"

sms.alpha_sender

string | null

default:Telnyx

The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.

sms.code_length

integer

default:5

The length of the verify code to generate.

Example:

6

sms.default_verification_timeout_secs

integer

default:300

For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.

Example:

300

call

CreateVerifyProfileCallRequest · object

Show child attributes

call.messaging_template_id

string<uuid>

The message template identifier selected from /verify_profiles/templates

Example:

"0abb5b4f-459f-445a-bfcd-488998b7572d"

call.app_name

string

The name that identifies the application requesting 2fa in the verification message.

Example:

"Example Secure App"

call.code_length

integer

default:5

The length of the verify code to generate.

Example:

6

call.whitelisted_destinations

string[]

Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code

Example:

["US", "CA"]

call.default_verification_timeout_secs

integer

default:300

Example:

300

flashcall

CreateVerifyProfileFlashcallRequest · object

Show child attributes

flashcall.whitelisted_destinations

string[]

Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code

Example:

["US", "CA"]

flashcall.default_verification_timeout_secs

integer

default:300

Example:

300

language

string

Example:

"en-US"

Response

Expected Verify profile response to a valid request.

data

VerifyProfileResponse · object

Show child attributes

data.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.name

string

Example:

"Test Profile"

data.webhook_url

string

Example:

"http://example.com/webhook"

data.webhook_failover_url

string

Example:

"http://example.com/webhook/failover"

data.record_type

enum<string>

The possible verification profile record types.

Available options:

verification_profile

Example:

"verification_profile"

data.created_at

string

Example:

"2020-09-14T17:03:32.965812"

data.updated_at

string

Example:

"2020-09-14T17:03:32.965812"

data.sms

VerifyProfileSMSResponse · object

Show child attributes

data.sms.messaging_template_id

string<uuid>

The message template identifier selected from /verify_profiles/templates

Example:

"0abb5b4f-459f-445a-bfcd-488998b7572d"

data.sms.app_name

string

The name that identifies the application requesting 2fa in the verification message.

Example:

"Example Secure App"

data.sms.alpha_sender

string | null

default:Telnyx

The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.

data.sms.code_length

integer

default:5

The length of the verify code to generate.

Example:

6

data.sms.whitelisted_destinations

string[]

Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code

Example:

["US", "CA"]

data.sms.default_verification_timeout_secs

integer

default:300

Example:

300

data.call

VerifyProfileCallResponse · object

Show child attributes

data.call.messaging_template_id

string<uuid>

The message template identifier selected from /verify_profiles/templates

Example:

"0abb5b4f-459f-445a-bfcd-488998b7572d"

data.call.app_name

string

The name that identifies the application requesting 2fa in the verification message.

Example:

"Example Secure App"

data.call.code_length

integer

default:5

The length of the verify code to generate.

Example:

6

data.call.whitelisted_destinations

string[]

Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code

Example:

["US", "CA"]

data.call.default_verification_timeout_secs

integer

default:300

Example:

300

data.flashcall

VerifyProfileFlashcallResponse · object

Show child attributes

data.flashcall.default_verification_timeout_secs

integer

default:300

Example:

300

data.language

string

Example:

"en-US"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup