Verification Status

Approved

com.twilio.accountsecurity.verify.verification.approved

Verification Status Approved events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.accountsecurity.verify.verification.approved",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/AccountSecurity.VerifyEventStreamEvent/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "account_sid" : "AC0000000000000000000000000000001",
10    "service_sid" : "VA0000000000000000000000000000001",
11    "verification_sid" : "VE0000000000000000000000000000001",
12    "friendly_name" : "My verification service",
13    "custom_code_enabled" : false,
14    "custom_friendly_name" : "My verification service",
15    "created_at" : "2025-01-01T00:00:00.000Z",
16    "verified_at" : "2025-01-01T00:00:01.000Z",
17    "to" : "+11234567890",
18    "verification_status" : "APPROVED",
19    "country" : "US",
20    "code_length" : 6,
21    "send_code_attempts" : {
22      "count" : 1,
23      "attempts" : [
24        {
25          "time" : "2025-01-01T00:00:00.000Z",
26          "channel" : "SMS",
27          "attempt_sid" : "VL0000000000000000000000000000001",
28          "delivery_status" : "UNDELIVERED",
29          "error_code" : "30004",
30          "locale" : "es"
31        }
32      ]
33    },
34    "check_attempts" : {
35      "count" : 0,
36      "attempts" : [
37        {
38          "time" : "2025-01-01T00:00:00.000Z",
39          "status" : "SUCCESS"
40        }
41      ]
42    },
43    "expired_at" : "2025-01-01T00:10:00.000Z"
44  }
45}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 2 is also available as a JSON schema.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 1 is also available as a JSON schema.

Canceled

com.twilio.accountsecurity.verify.verification.canceled

Verification Status Canceled events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.accountsecurity.verify.verification.canceled",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/AccountSecurity.VerifyEventStreamEvent/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "account_sid" : "AC0000000000000000000000000000001",
10    "service_sid" : "VA0000000000000000000000000000001",
11    "verification_sid" : "VE0000000000000000000000000000001",
12    "friendly_name" : "My verification service",
13    "custom_code_enabled" : false,
14    "custom_friendly_name" : "My verification service",
15    "created_at" : "2025-01-01T00:00:00.000Z",
16    "verified_at" : "2025-01-01T00:00:01.000Z",
17    "to" : "+11234567890",
18    "verification_status" : "APPROVED",
19    "country" : "US",
20    "code_length" : 6,
21    "send_code_attempts" : {
22      "count" : 1,
23      "attempts" : [
24        {
25          "time" : "2025-01-01T00:00:00.000Z",
26          "channel" : "SMS",
27          "attempt_sid" : "VL0000000000000000000000000000001",
28          "delivery_status" : "UNDELIVERED",
29          "error_code" : "30004",
30          "locale" : "es"
31        }
32      ]
33    },
34    "check_attempts" : {
35      "count" : 0,
36      "attempts" : [
37        {
38          "time" : "2025-01-01T00:00:00.000Z",
39          "status" : "SUCCESS"
40        }
41      ]
42    },
43    "expired_at" : "2025-01-01T00:10:00.000Z"
44  }
45}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 2 is also available as a JSON schema.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 1 is also available as a JSON schema.

Expired

com.twilio.accountsecurity.verify.verification.expired

Verification Status Expired events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.accountsecurity.verify.verification.expired",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/AccountSecurity.VerifyEventStreamEvent/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "account_sid" : "AC0000000000000000000000000000001",
10    "service_sid" : "VA0000000000000000000000000000001",
11    "verification_sid" : "VE0000000000000000000000000000001",
12    "friendly_name" : "My verification service",
13    "custom_code_enabled" : false,
14    "custom_friendly_name" : "My verification service",
15    "created_at" : "2025-01-01T00:00:00.000Z",
16    "verified_at" : "2025-01-01T00:00:01.000Z",
17    "to" : "+11234567890",
18    "verification_status" : "APPROVED",
19    "country" : "US",
20    "code_length" : 6,
21    "send_code_attempts" : {
22      "count" : 1,
23      "attempts" : [
24        {
25          "time" : "2025-01-01T00:00:00.000Z",
26          "channel" : "SMS",
27          "attempt_sid" : "VL0000000000000000000000000000001",
28          "delivery_status" : "UNDELIVERED",
29          "error_code" : "30004",
30          "locale" : "es"
31        }
32      ]
33    },
34    "check_attempts" : {
35      "count" : 0,
36      "attempts" : [
37        {
38          "time" : "2025-01-01T00:00:00.000Z",
39          "status" : "SUCCESS"
40        }
41      ]
42    },
43    "expired_at" : "2025-01-01T00:10:00.000Z"
44  }
45}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 2 is also available as a JSON schema.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 1 is also available as a JSON schema.

Max Attempts Reached

com.twilio.accountsecurity.verify.verification.max-attempts-reached

Verification Status Max Attempts Reached events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.accountsecurity.verify.verification.max-attempts-reached",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/AccountSecurity.VerifyEventStreamEvent/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "account_sid" : "AC0000000000000000000000000000001",
10    "service_sid" : "VA0000000000000000000000000000001",
11    "verification_sid" : "VE0000000000000000000000000000001",
12    "friendly_name" : "My verification service",
13    "custom_code_enabled" : false,
14    "custom_friendly_name" : "My verification service",
15    "created_at" : "2025-01-01T00:00:00.000Z",
16    "verified_at" : "2025-01-01T00:00:01.000Z",
17    "to" : "+11234567890",
18    "verification_status" : "APPROVED",
19    "country" : "US",
20    "code_length" : 6,
21    "send_code_attempts" : {
22      "count" : 1,
23      "attempts" : [
24        {
25          "time" : "2025-01-01T00:00:00.000Z",
26          "channel" : "SMS",
27          "attempt_sid" : "VL0000000000000000000000000000001",
28          "delivery_status" : "UNDELIVERED",
29          "error_code" : "30004",
30          "locale" : "es"
31        }
32      ]
33    },
34    "check_attempts" : {
35      "count" : 0,
36      "attempts" : [
37        {
38          "time" : "2025-01-01T00:00:00.000Z",
39          "status" : "SUCCESS"
40        }
41      ]
42    },
43    "expired_at" : "2025-01-01T00:10:00.000Z"
44  }
45}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 2 is also available as a JSON schema.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 1 is also available as a JSON schema.

Pending

com.twilio.accountsecurity.verify.verification.pending

Verification Status Pending events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.accountsecurity.verify.verification.pending",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/AccountSecurity.VerifyEventStreamEvent/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "account_sid" : "AC0000000000000000000000000000001",
10    "service_sid" : "VA0000000000000000000000000000001",
11    "verification_sid" : "VE0000000000000000000000000000001",
12    "friendly_name" : "My verification service",
13    "custom_code_enabled" : false,
14    "custom_friendly_name" : "My verification service",
15    "created_at" : "2025-01-01T00:00:00.000Z",
16    "verified_at" : "2025-01-01T00:00:01.000Z",
17    "to" : "+11234567890",
18    "verification_status" : "APPROVED",
19    "country" : "US",
20    "code_length" : 6,
21    "send_code_attempts" : {
22      "count" : 1,
23      "attempts" : [
24        {
25          "time" : "2025-01-01T00:00:00.000Z",
26          "channel" : "SMS",
27          "attempt_sid" : "VL0000000000000000000000000000001",
28          "delivery_status" : "UNDELIVERED",
29          "error_code" : "30004",
30          "locale" : "es"
31        }
32      ]
33    },
34    "check_attempts" : {
35      "count" : 0,
36      "attempts" : [
37        {
38          "time" : "2025-01-01T00:00:00.000Z",
39          "status" : "SUCCESS"
40        }
41      ]
42    },
43    "expired_at" : "2025-01-01T00:10:00.000Z"
44  }
45}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 2 is also available as a JSON schema.

string account_sid (required). The SID of the Account that created the Verification resource.
string service_sid (required). The SID of the Service used to generate the Verification resource.
string verification_sid (required). The SID created to uniquely identify the Verification resource.
string friendly_name (required). A custom user defined string to describe the verification service.
boolean custom_code_enabled (required). A boolean value to define whether verifications are allowed to be sent with a custom code instead of a randomly generated one.
string custom_friendly_name. An optional custom user defined string to describe the verification service.
string created_at (required). The date when the resource was created, given in ISO 8601 format.
string verified_at. The date when the resource was verified, given in ISO 8601 format.
string to (required). Destination of a verification. It is phone number in E.164 format.
string verification_status (required). The status of the verification.
string country (required). Country code.
integer code_length. The length of the generated verification code.
object send_code_attempts (required). SendCodeAttempts definition.
- integer count (required). The number of attempts sent as a part of a verification.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Attempt was created, given in ISO 8601 format.
  - string channel (required). A string specifying the communication channel used for the verification attempt, i.e. SMS, CALL, WHATSAPP etc.
  - string attempt_sid (required). The SID that uniquely identifies the delivery attempt resource.
  - string delivery_status. The delivery status of the attempt. Possible values can be Accepted, Queued, Sent, Failed, Delivered & Undelivered.
  - string error_code. The error code generated from a Verification send attempt.
  - string locale (required). The locale will automatically resolve based on phone number country code for SMS, Call and WhatsApp channel verifications.
object check_attempts (required). CheckAttempts definition.
- integer count (required). The number of times verification was checked.
- object[] attempts. An array of objects containing information about the each attempt.
  - string time (required). The date that the Verification Attempt was checked, given in ISO 8601 format.
  - string status (required). The status of the Verification Check Attempt check. Possible values can be SUCCESS or FAILURE.
string expired_at. The date when the resource will expire, given in ISO 8601 format.

The full specification for version 1 is also available as a JSON schema.