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.
必要なもの:
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.
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the Verification resource. |
service_sid
|
The SID of the Service the resource is associated with. |
account_sid
|
The SID of the Account that created the Verification resource. |
to
|
The phone number or email being verified. Phone numbers must be in E.164 format. |
channel
|
The verification method used. One of: |
status
|
The status of the verification. One of: |
valid
|
Use "status" instead. Legacy property indicating whether the verification was successful. |
lookup
|
Information about the phone number being verified. |
amount
|
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
payee
|
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
send_code_attempts
|
An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID. |
date_created
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
url
|
The absolute URL of the Verification resource. |
Start New Verification
https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications
To verify a user's phone number or email, 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.
Phone numbers must be in E.164 format. Learn more about how to turn phone number input into E.164 format.
パラメーター
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the verification Service to create the resource under. |
to
必須
|
The phone number or email to verify. Phone numbers must be in E.164 format. |
channel
必須
|
The verification method to use. Can be: |
custom_friendly_name
オプション
|
A custom user defined friendly name that overwrites the existing one in the verification message |
send_digits
オプション
|
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
オプション
|
The locale to use for the verification SMS, WhatsApp or call. Can be: |
custom_code
オプション
|
A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive. |
amount
オプション
|
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
payee
オプション
|
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
rate_limits
オプション
|
The custom key-value pairs of Programmable Rate Limits. Keys correspond to |
channel_configuration
オプション
|
|
app_hash
オプション
|
Your App Hash to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: |
例 1
例 2
The WhatsApp channel is currently in the Pilot maturity stage, which means that you need to contact sales to request that your Twilio account gets access to it. The WhatsApp channel will not work without this access. Please start at the Verify WhatsApp Overview.
例 3
例 4
例 5
例 6
Email Channel Configuration
Verify's email channel requires additional Service configuration. Please refer to the email channel setup documentation for detailed instructions.
The email ChannelConfiguration parameter is an object that supports the following keys:
from |
文字列 | Required if submitting the ChannelConfiguration parameter. |
from_name |
文字列 | Required if submitting the ChannelConfiguration parameter. |
template_id |
文字列 |
Override the default template from the Verify Service email integration. Create a new template in the SendGrid dashboard or learn more in the SendGrid docs. |
substitutions |
オブジェクト |
Variable substitution for dynamic email templates (learn more). i.e. |
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.
Fetch a Verification
https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid}
パラメーター
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the verification Service to fetch the resource from. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Verification resource to fetch. |
例 1
Update a Verification Status
https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid}
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.
パラメーター
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the verification Service to update the resource from. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Verification resource to update. |
status
必須
|
The new status of the resource. Can be: |
例 1
例 2
Next: Check a Verification
Validate if the code a user provided was correct with the Verification Check Resource.
ヘルプが必要ですか？
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.