Create a Verify profile

POST 
/verify_profiles

Creates a new Verify profile to associate verifications with.

Request

application/json

Body

required

name stringrequired
webhook_url string
webhook_failover_url string

sms

object

messaging_template_id uuid

The message template identifier selected from /verify_profiles/templates

app_name string

Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

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

alpha_sender stringnullable

Possible values: Value must match regular expression ^[A-Za-z0-9 ]{1,11}$

Default value: Telnyx

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

code_length integer

Default value: 5

The length of the verify code to generate.

whitelisted_destinations string[]required

Possible values: Value must match regular expression ^[A-Z]{2}$

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.

default_verification_timeout_secs integer

Default value: 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.

call

object

messaging_template_id uuid

The message template identifier selected from /verify_profiles/templates

app_name string

Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

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

code_length integer

Default value: 5

The length of the verify code to generate.

whitelisted_destinations string[]

Possible values: Value must match regular expression ^[A-Z]{2}$

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.

default_verification_timeout_secs integer

Default value: 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.

flashcall

object

whitelisted_destinations string[]

Possible values: Value must match regular expression ^[A-Z]{2}$

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.

default_verification_timeout_secs integer

Default value: 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.

language string

Responses

200: Expected Verify profile response to a valid request.

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

name string

webhook_url string

webhook_failover_url string

record_type VerificationProfileRecordType (string)

Possible values: [verification_profile]

The possible verification profile record types.

created_at string

updated_at string

sms

object

messaging_template_id uuid

The message template identifier selected from /verify_profiles/templates

app_name string

Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

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

alpha_sender stringnullable

Possible values: Value must match regular expression ^[A-Za-z0-9 ]{1,11}$

Default value: Telnyx

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

code_length integer

Default value: 5

The length of the verify code to generate.

whitelisted_destinations string[]

Possible values: Value must match regular expression ^[A-Z]{2}$

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.

default_verification_timeout_secs integer

Default value: 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.

call

object

messaging_template_id uuid

The message template identifier selected from /verify_profiles/templates

app_name string

Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

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

code_length integer

Default value: 5

The length of the verify code to generate.

whitelisted_destinations string[]

Possible values: Value must match regular expression ^[A-Z]{2}$

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.

default_verification_timeout_secs integer

Default value: 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.

flashcall

object

default_verification_timeout_secs integer

Default value: 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.

language string

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

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10015",
      "title": "Invalid sorting value",
      "detail": "The value provided for sorting is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/sort",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/verify_profiles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "Test Profile",
  "webhook_url": "http://example.com/webhook",
  "webhook_failover_url": "http://example.com/webhook/failover",
  "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": {
    "whitelisted_destinations": [
      "US",
      "CA"
    ],
    "default_verification_timeout_secs": 300
  },
  "language": "en-US"
}'

Response samples

• 200
• 400

---

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

{
  "errors": [
    {
      "code": "10015",
      "title": "Invalid sorting value",
      "detail": "The value provided for sorting is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/sort",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}