Verify API

Two factor authentication API

List verifications by phone number

SecuritybearerAuth
Request
path Parameters
phone_number
required
string

The phone number associated with the verifications to retrieve.

Example: +13035551234
Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
Array of objects (Verification)
required
object (Meta)
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/verifications/by_phone_number/{phone_number}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Verification.ByPhoneNumber.list('+13035551234')
Response samples
application/json
{
  • "data": [
    • {
      • "call_timeout_secs": 299,
      • "created_at": "2020-09-14T17:03:32.965812",
      • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      • "phone_number": "+13035551234",
      • "record_type": "verification",
      • "status": "accepted",
      • "timeout_secs": 300,
      • "type": "sms",
      • "updated_at": "2020-09-14T17:03:32.965812",
      • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.

SecuritybearerAuth
Request
path Parameters
phone_number
required
string

The phone number associated with the verification code being verified.

Example: +13035551234
Request Body schema: application/json
required
code
required
string

This is the code the user submits for verification.

verify_profile_id
required
string <uuid>

The identifier of the associated Verify profile.

Responses
200

Expected verify response to a valid request.

Response Schema: application/json
required
object
phone_number
required
string

+E164 formatted phone number.

response_code
required
string

Identifies if the verification code has been accepted or rejected.

Enum: "accepted" "rejected"
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verifications/by_phone_number/{phone_number}/actions/verify
Request samples
application/json
{
  • "code": "17686",
  • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
Response samples
application/json
{
  • "data": {
    • "phone_number": "+13035551234",
    • "response_code": "accepted"
    }
}

Trigger a Call verification

SecuritybearerAuth
Request
Request Body schema: application/json
required
call_timeout_secs
integer

Must be less than the profile's default_verification_timeout_secs or timeout_secs, whichever is lesser.

phone_number
required
string

+E164 formatted phone number.

timeout_secs
integer

The number of seconds the verification code is valid for.

verify_profile_id
required
string <uuid>

The identifier of the associated Verify profile.

Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
object (Verification)
call_timeout_secs
integer

This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

created_at
string
id
string <uuid>
phone_number
string

+E164 formatted phone number.

record_type
string (VerificationRecordType)

The possible verification record types.

Value: "verification"
status
string (VerificationStatus)

The possible statuses of the verification request.

Enum: "pending" "sms_delivery_failed" "accepted" "expired" "not_enough_credit" "network_error" "number_unreachable" "internal_error" "invalid_destination" "timed_out"
timeout_secs
integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

type
string (VerificationType)

The possible types of verification.

Enum: "sms" "psd2" "call" "flashcall"
updated_at
string
verify_profile_id
string <uuid>

The identifier of the associated Verify profile.

400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verifications/call
Request samples
application/json
{
  • "call_timeout_secs": 30,
  • "phone_number": "+13035551234",
  • "timeout_secs": 300,
  • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
Response samples
application/json
{
  • "data": {
    • "call_timeout_secs": 299,
    • "created_at": "2020-09-14T17:03:32.965812",
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "phone_number": "+13035551234",
    • "record_type": "verification",
    • "status": "accepted",
    • "timeout_secs": 300,
    • "type": "sms",
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
    }
}

Trigger a Flash call verification

SecuritybearerAuth
Request
Request Body schema: application/json
required
phone_number
required
string

+E164 formatted phone number.

timeout_secs
integer

The number of seconds the verification code is valid for.

verify_profile_id
required
string <uuid>

The identifier of the associated Verify profile.

Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
object (Verification)
call_timeout_secs
integer

This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

created_at
string
id
string <uuid>
phone_number
string

+E164 formatted phone number.

record_type
string (VerificationRecordType)

The possible verification record types.

Value: "verification"
status
string (VerificationStatus)

The possible statuses of the verification request.

Enum: "pending" "sms_delivery_failed" "accepted" "expired" "not_enough_credit" "network_error" "number_unreachable" "internal_error" "invalid_destination" "timed_out"
timeout_secs
integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

type
string (VerificationType)

The possible types of verification.

Enum: "sms" "psd2" "call" "flashcall"
updated_at
string
verify_profile_id
string <uuid>

The identifier of the associated Verify profile.

400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verifications/flashcall
Request samples
application/json
{
  • "phone_number": "+13035551234",
  • "timeout_secs": 300,
  • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
Response samples
application/json
{
  • "data": {
    • "call_timeout_secs": 299,
    • "created_at": "2020-09-14T17:03:32.965812",
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "phone_number": "+13035551234",
    • "record_type": "verification",
    • "status": "accepted",
    • "timeout_secs": 300,
    • "type": "sms",
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
    }
}

Trigger a PSD2 verification

SecuritybearerAuth
Request
Request Body schema: application/json
required
amount
required
string
currency
required
string (Currencies)

The supported currencies.

Enum: "USD" "EUR" "GBP" "AUD" "CAD"
payee
required
string
phone_number
required
string

+E164 formatted phone number.

timeout_secs
integer

The number of seconds the verification code is valid for.

verify_profile_id
required
string <uuid>

The identifier of the associated Verify profile.

Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
object (Verification)
call_timeout_secs
integer

This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

created_at
string
id
string <uuid>
phone_number
string

+E164 formatted phone number.

record_type
string (VerificationRecordType)

The possible verification record types.

Value: "verification"
status
string (VerificationStatus)

The possible statuses of the verification request.

Enum: "pending" "sms_delivery_failed" "accepted" "expired" "not_enough_credit" "network_error" "number_unreachable" "internal_error" "invalid_destination" "timed_out"
timeout_secs
integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

type
string (VerificationType)

The possible types of verification.

Enum: "sms" "psd2" "call" "flashcall"
updated_at
string
verify_profile_id
string <uuid>

The identifier of the associated Verify profile.

400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verifications/psd2
Request samples
application/json
{
  • "amount": "99.99",
  • "currency": "USD",
  • "payee": "Acme Corp Inc. LTD",
  • "phone_number": "+13035551234",
  • "timeout_secs": 300,
  • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
Response samples
application/json
{
  • "data": {
    • "call_timeout_secs": 299,
    • "created_at": "2020-09-14T17:03:32.965812",
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "phone_number": "+13035551234",
    • "record_type": "verification",
    • "status": "accepted",
    • "timeout_secs": 300,
    • "type": "sms",
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
    }
}

Trigger a SMS verification

SecuritybearerAuth
Request
Request Body schema: application/json
required
phone_number
required
string

+E164 formatted phone number.

timeout_secs
integer

The number of seconds the verification code is valid for.

verify_profile_id
required
string <uuid>

The identifier of the associated Verify profile.

Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
object (Verification)
call_timeout_secs
integer

This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

created_at
string
id
string <uuid>
phone_number
string

+E164 formatted phone number.

record_type
string (VerificationRecordType)

The possible verification record types.

Value: "verification"
status
string (VerificationStatus)

The possible statuses of the verification request.

Enum: "pending" "sms_delivery_failed" "accepted" "expired" "not_enough_credit" "network_error" "number_unreachable" "internal_error" "invalid_destination" "timed_out"
timeout_secs
integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

type
string (VerificationType)

The possible types of verification.

Enum: "sms" "psd2" "call" "flashcall"
updated_at
string
verify_profile_id
string <uuid>

The identifier of the associated Verify profile.

400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verifications/sms
Request samples
application/json
{
  • "phone_number": "+13035551234",
  • "timeout_secs": 300,
  • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
Response samples
application/json
{
  • "data": {
    • "call_timeout_secs": 299,
    • "created_at": "2020-09-14T17:03:32.965812",
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "phone_number": "+13035551234",
    • "record_type": "verification",
    • "status": "accepted",
    • "timeout_secs": 300,
    • "type": "sms",
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
    }
}

Retrieve a verification

SecuritybearerAuth
Request
path Parameters
verification_id
required
string <uuid>

The identifier of the verification to retrieve.

Example: 12ade33a-21c0-473b-b055-b3c836e1c292
Responses
200

Expected verifications response to a valid request.

Response Schema: application/json
required
object (Verification)
call_timeout_secs
integer

This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

created_at
string
id
string <uuid>
phone_number
string

+E164 formatted phone number.

record_type
string (VerificationRecordType)

The possible verification record types.

Value: "verification"
status
string (VerificationStatus)

The possible statuses of the verification request.

Enum: "pending" "sms_delivery_failed" "accepted" "expired" "not_enough_credit" "network_error" "number_unreachable" "internal_error" "invalid_destination" "timed_out"
timeout_secs
integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

type
string (VerificationType)

The possible types of verification.

Enum: "sms" "psd2" "call" "flashcall"
updated_at
string
verify_profile_id
string <uuid>

The identifier of the associated Verify profile.

400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/verifications/{verification_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Verification.retrieve(verification_id)
Response samples
application/json
{
  • "data": {
    • "call_timeout_secs": 299,
    • "created_at": "2020-09-14T17:03:32.965812",
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "phone_number": "+13035551234",
    • "record_type": "verification",
    • "status": "accepted",
    • "timeout_secs": 300,
    • "type": "sms",
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
    }
}

List all Verify profiles

Gets a paginated list of Verify profiles.

SecuritybearerAuth
Request
query Parameters
filter[name]
string (filter[name])

Optional filter for profile names.

page[size]
integer (page[size])
Default: 25
page[number]
integer (page[number])
Default: 1
Responses
200

Expected Verify profile response to a valid request.

Response Schema: application/json
required
Array of objects (VerifyProfileResponse)
required
object (Meta)
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/verify_profiles
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.VerifyProfile.list()
Response samples
application/json
{
  • "data": [
    • {
      • "call": {
        • "default_call_timeout_secs": 30,
        • "default_verification_timeout_secs": 300,
        • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}."
        },
      • "created_at": "2020-09-14T17:03:32.965812",
      • "flashcall": {
        • "default_verification_timeout_secs": 300
        },
      • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      • "language": "en-US",
      • "name": "Test Profile",
      • "psd2": {
        • "default_verification_timeout_secs": 300
        },
      • "record_type": "verification_profile",
      • "sms": {
        • "default_verification_timeout_secs": 300,
        • "messaging_enabled": true,
        • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
        • "rcs_enabled": true,
        • "vsms_enabled": true
        },
      • "updated_at": "2020-09-14T17:03:32.965812",
      • "webhook_failover_url": "http://example.com/webhook/failover",
      • "webhook_url": "http://example.com/webhook"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create a Verify profile

Creates a new Verify profile to associate verifications with.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (CreateVerifyProfileCallRequest)
object (CreateVerifyProfileFlashcallRequest)
language
string
name
required
string
object (CreateVerifyProfilePSD2Request)
object (CreateVerifyProfileSMSRequest)
webhook_failover_url
string
webhook_url
string
Responses
200

Expected Verify profile response to a valid request.

Response Schema: application/json
object (VerifyProfileResponse)
object (VerifyProfileCallResponse)
created_at
string
object (VerifyProfileFlashcallResponse)
id
string <uuid>
language
string
name
string
object (VerifyProfilePSD2Response)
record_type
string (VerificationProfileRecordType)

The possible verification profile record types.

Value: "verification_profile"
object (VerifyProfileSMSResponse)
updated_at
string
webhook_failover_url
string
webhook_url
string
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/verify_profiles
Request samples
application/json
{
  • "call": {
    • "default_call_timeout_secs": 30,
    • "default_verification_timeout_secs": 300,
    • "msg_template": "Hello, this is the Acme Inc verification code you requested: {code}."
    },
  • "flashcall": {
    • "default_verification_timeout_secs": 300
    },
  • "language": "en-US",
  • "name": "Test Profile",
  • "psd2": {
    • "default_verification_timeout_secs": 300
    },
  • "sms": {
    • "default_verification_timeout_secs": 300,
    • "messaging_enabled": true,
    • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
    • "rcs_enabled": true,
    • "vsms_enabled": true
    },
  • "webhook_failover_url": "http://example.com/webhook/failover",
  • "webhook_url": "http://example.com/webhook"
}
Response samples
application/json
{
  • "data": {
    • "call": {
      • "default_call_timeout_secs": 30,
      • "default_verification_timeout_secs": 300,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}."
      },
    • "created_at": "2020-09-14T17:03:32.965812",
    • "flashcall": {
      • "default_verification_timeout_secs": 300
      },
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "language": "en-US",
    • "name": "Test Profile",
    • "psd2": {
      • "default_verification_timeout_secs": 300
      },
    • "record_type": "verification_profile",
    • "sms": {
      • "default_verification_timeout_secs": 300,
      • "messaging_enabled": true,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
      • "rcs_enabled": true,
      • "vsms_enabled": true
      },
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "webhook_failover_url": "http://example.com/webhook/failover",
    • "webhook_url": "http://example.com/webhook"
    }
}

Delete a Verify profile

SecuritybearerAuth
Request
path Parameters
verify_profile_id
required
string <uuid>

The identifier of the Verify profile to delete.

Example: 12ade33a-21c0-473b-b055-b3c836e1c292
Responses
200

Expected Verify profile response to a valid request.

Response Schema: application/json
object (VerifyProfileResponse)
object (VerifyProfileCallResponse)
created_at
string
object (VerifyProfileFlashcallResponse)
id
string <uuid>
language
string
name
string
object (VerifyProfilePSD2Response)
record_type
string (VerificationProfileRecordType)

The possible verification profile record types.

Value: "verification_profile"
object (VerifyProfileSMSResponse)
updated_at
string
webhook_failover_url
string
webhook_url
string
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
delete/verify_profiles/{verify_profile_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.VerifyProfile.retrieve(verify_profile_id)
res.delete()
Response samples
application/json
{
  • "data": {
    • "call": {
      • "default_call_timeout_secs": 30,
      • "default_verification_timeout_secs": 300,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}."
      },
    • "created_at": "2020-09-14T17:03:32.965812",
    • "flashcall": {
      • "default_verification_timeout_secs": 300
      },
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "language": "en-US",
    • "name": "Test Profile",
    • "psd2": {
      • "default_verification_timeout_secs": 300
      },
    • "record_type": "verification_profile",
    • "sms": {
      • "default_verification_timeout_secs": 300,
      • "messaging_enabled": true,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
      • "rcs_enabled": true,
      • "vsms_enabled": true
      },
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "webhook_failover_url": "http://example.com/webhook/failover",
    • "webhook_url": "http://example.com/webhook"
    }
}

Retrieve a Verify profile

Gets a single Verify profile.

SecuritybearerAuth
Request
path Parameters
verify_profile_id
required
string <uuid>

The identifier of the Verify profile to retrieve.

Example: 12ade33a-21c0-473b-b055-b3c836e1c292
Responses
200

Expected Verify profile response to a valid request.

Response Schema: application/json
object (VerifyProfileResponse)
object (VerifyProfileCallResponse)
created_at
string
object (VerifyProfileFlashcallResponse)
id
string <uuid>
language
string
name
string
object (VerifyProfilePSD2Response)
record_type
string (VerificationProfileRecordType)

The possible verification profile record types.

Value: "verification_profile"
object (VerifyProfileSMSResponse)
updated_at
string
webhook_failover_url
string
webhook_url
string
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/verify_profiles/{verify_profile_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.VerifyProfile.retrieve(verify_profile_id)
Response samples
application/json
{
  • "data": {
    • "call": {
      • "default_call_timeout_secs": 30,
      • "default_verification_timeout_secs": 300,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}."
      },
    • "created_at": "2020-09-14T17:03:32.965812",
    • "flashcall": {
      • "default_verification_timeout_secs": 300
      },
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "language": "en-US",
    • "name": "Test Profile",
    • "psd2": {
      • "default_verification_timeout_secs": 300
      },
    • "record_type": "verification_profile",
    • "sms": {
      • "default_verification_timeout_secs": 300,
      • "messaging_enabled": true,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
      • "rcs_enabled": true,
      • "vsms_enabled": true
      },
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "webhook_failover_url": "http://example.com/webhook/failover",
    • "webhook_url": "http://example.com/webhook"
    }
}

Update a Verify profile

SecuritybearerAuth
Request
path Parameters
verify_profile_id
required
string <uuid>

The identifier of the Verify profile to update.

Example: 12ade33a-21c0-473b-b055-b3c836e1c292
Request Body schema: application/json
required
object (UpdateVerifyProfileCallRequest)
object (UpdateVerifyProfileFlashcallRequest)
language
string
name
string
object (UpdateVerifyProfilePSD2Request)
object (UpdateVerifyProfileSMSRequest)
webhook_failover_url
string
webhook_url
string
Responses
200

Expected Verify profile response to a valid request.

Response Schema: application/json
object (VerifyProfileResponse)
object (VerifyProfileCallResponse)
created_at
string
object (VerifyProfileFlashcallResponse)
id
string <uuid>
language
string
name
string
object (VerifyProfilePSD2Response)
record_type
string (VerificationProfileRecordType)

The possible verification profile record types.

Value: "verification_profile"
object (VerifyProfileSMSResponse)
updated_at
string
webhook_failover_url
string
webhook_url
string
400

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
patch/verify_profiles/{verify_profile_id}
Request samples
application/json
{
  • "call": {
    • "default_call_timeout_secs": 30,
    • "default_verification_timeout_secs": 300,
    • "msg_template": "Hello, this is the Acme Inc verification code you requested: {code}."
    },
  • "flashcall": {
    • "default_verification_timeout_secs": 300
    },
  • "language": "en-US",
  • "name": "Test Profile",
  • "psd2": {
    • "default_verification_timeout_secs": 300
    },
  • "sms": {
    • "default_verification_timeout_secs": 300,
    • "messaging_enabled": true,
    • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
    • "rcs_enabled": true,
    • "vsms_enabled": true
    },
  • "webhook_failover_url": "http://example.com/webhook/failover",
  • "webhook_url": "http://example.com/webhook"
}
Response samples
application/json
{
  • "data": {
    • "call": {
      • "default_call_timeout_secs": 30,
      • "default_verification_timeout_secs": 300,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}."
      },
    • "created_at": "2020-09-14T17:03:32.965812",
    • "flashcall": {
      • "default_verification_timeout_secs": 300
      },
    • "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    • "language": "en-US",
    • "name": "Test Profile",
    • "psd2": {
      • "default_verification_timeout_secs": 300
      },
    • "record_type": "verification_profile",
    • "sms": {
      • "default_verification_timeout_secs": 300,
      • "messaging_enabled": true,
      • "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
      • "rcs_enabled": true,
      • "vsms_enabled": true
      },
    • "updated_at": "2020-09-14T17:03:32.965812",
    • "webhook_failover_url": "http://example.com/webhook/failover",
    • "webhook_url": "http://example.com/webhook"
    }
}