Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

Create a new Verification using a Service

post/v2/Services/{ServiceSid}/Verifications

Path parameters

ServiceSidstring required

The SID of the verification Service to create the resource under.

Response

Created

account_sidstring nullable

The SID of the Account that created the Verification resource.

amountstring nullable

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

channel'sms' | 'call' | 'email' | 'whatsapp' | 'sna'
date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

{"stackTrail":"components:schemas:verify.v2.service.verification:properties:lookup","oasType":"schema","type":"unknown","description":"Information about the phone number being verified.","nullable":true}
payeestring nullable

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

service_sidstring nullable

The SID of the Service the resource is associated with.

sidstring nullable

The unique string that we created to identify the Verification resource.

{"stackTrail":"components:schemas:verify.v2.service.verification:properties:sna","oasType":"schema","type":"unknown","description":"The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number.","nullable":true}
statusstring nullable

The status of the verification. One of: pending, approved, or canceled

tostring nullable

The phone number or email being verified. Phone numbers must be in E.164 format.

urlstring uri nullable

The absolute URL of the Verification resource.

validboolean nullable

Use "status" instead. Legacy property indicating whether the verification was successful.