Verifications

The Twilio Verify REST API allows you to verify that a user has a claimed device in their possession. The API lets you request a verification code to be sent to the user and to check that a received code is valid.

必要なもの:

Create a Verification Service

Verification Response Properties

These fields are returned in the output JSON response. The type SID<VE> is a unique ID starting with the letters VE.

Names in PHP format
`sid`	sid<VE> Not PII The unique string that we created to identify the Verification resource.
`serviceSid`	sid<VA> Not PII The SID of the Service the resource is associated with.
`accountSid`	sid<AC> Not PII The SID of the Account that created the Verification resource.
`to`	phone_number PII MTL: 30 DAYS The phone number being verified. Must be in E.164 format.
`channel`	enum:channel Not PII The verification method to use. Can be: `sms` or `call`.
`status`	文字列 Not PII The status of the verification. Can be: `pending`, `approved`, `denied`, or `expired`.
`valid`	boolean Not PII Whether the verification was successful.
`lookup`	オブジェクト Not PII Information about the phone number being verified.
`amount`	文字列 PII MTL: 1 DAYS The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`payee`	文字列 PII MTL: 1 DAYS The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`dateCreated`	date_time<iso8601> Not PII The date and time in GMT when the resource was created specified in RFC 2822 format.
`dateUpdated`	date_time<iso8601> Not PII The date and time in GMT when the resource was last updated specified in RFC 2822 format.
`url`	url Not PII The absolute URL of the Verification resource.

Start New Verification

post

https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications

To verify a user's phone number, you will start by requesting to send a verification code to their device.

These are the available input parameters for starting a verification. The type SID<VE> is a unique ID starting with the letters VE.

Localization and Supported Languages

Verify supports delivering verification codes in more than 30 languages over both voice and SMS. To find out more about which languages are supported visit our page on Localization and Supported Languages.

Canadian Carrier Data Support

By default, Verify will not return carrier data for Candian phone numbers. If you need carrier data on Canadian phone numbers, please visit our support site to enable this feature.

パラメーター

Names in None format
`service_sid` 必須	post sid<VA> Not PII The SID of the verification Service to create the resource under.
`to` 必須	post 文字列 PII MTL: 30 DAYS The phone number to verify.
`channel` 必須	post 文字列 Not PII The verification method to use. Can be: `sms` or `call`.
`send_digits` オプション	post 文字列 Not PII The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of sendDigits.
`locale` オプション	post 文字列 Not PII The locale to use for the verification SMS or call. Can be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`
`custom_code` オプション	post 文字列 Not PII A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
`amount` オプション	post 文字列 PII MTL: 1 DAYS The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`payee` オプション	post 文字列 PII MTL: 1 DAYS The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`rate_limits` オプション	post オブジェクト Not PII The custom key-value pairs of Programmable Rate Limits. Keys should be the unique_name configured while creating you Rate Limit along with the associated values for each particular request. You may include multiple Rate Limit values in each request.

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Start a Verification with SMS

例 2

Loading Code Sample...

Next Sample

出力を表示

出力

Start a Verification with Voice

Fetch a Verification

GET

https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid}

パラメーター

Names in None format

Names in None format
`service_sid` 必須	GET sid<VA> Not PII The SID of the verification Service to fetch the resource from.
`sid` 必須	GET 文字列 Not PII The Twilio-provided string that uniquely identifies the Verification resource to fetch.

service_sid

必須

GET sid<VA> Not PII

The SID of the verification Service to fetch the resource from.

sid

必須

GET 文字列 Not PII

The Twilio-provided string that uniquely identifies the Verification resource to fetch.

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Fetch a Verification by SID

Update a Verification Status

post

https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid}

Use this endpoint only if using Custom Verification Codes.

Mark the verification as "approved" after your application had validated the verification code.

Mark the verification as "canceled" to start a new verification with a different code before the previous code expires (10 minutes).

For most other use cases, Verify is able to manage the complete lifecycle of a verification with the Verification Check Resource.

パラメーター

Names in None format

Names in None format
`service_sid` 必須	post sid<VA> Not PII The SID of the verification Service to update the resource from.
`sid` 必須	post 文字列 Not PII The Twilio-provided string that uniquely identifies the Verification resource to update.
`status` 必須	post enum:status Not PII The new status of the resource. Can be: `canceled` or `approved`.

service_sid

必須

post sid<VA> Not PII

The SID of the verification Service to update the resource from.

sid

必須

post 文字列 Not PII

The Twilio-provided string that uniquely identifies the Verification resource to update.

status

必須

post enum:status Not PII

The new status of the resource. Can be: canceled or approved.