Sign in
VerifyV2Verification

Create a new Verification using a Service

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

sidstring nullable

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

service_sidstring nullable

The SID of the Service the resource is associated with.

account_sidstring nullable

The SID of the Account that created the Verification resource.

tostring nullable

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

channel'sms' | 'call' | 'email' | 'whatsapp' | 'sna'

The verification method used. One of: email, sms, whatsapp, call, sna, or rcs.

statusstring nullable

The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.

validboolean nullable

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

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

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

payeestring nullable

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

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: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}
urlstring uri nullable

The absolute URL of the Verification resource.

Changes

Changed in 12 of the 52 revisions of this API.8111

  • v2995c3e7a8bfb1See the full diff
    • ○

      added the new optional request property Templates

      new-optional-request-property

  • v2d5d7b4a5714f1See the full diff
    • ○

      the endpoint scheme security access_token_bearer was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v2b71afcaa62a21See the full diff
    • ○

      request property CustomMessage deprecated

      request-property-deprecated

  • v26b965f05f2ee1See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • v21548692e680432See the full diff
    • ▲

      the lookup response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ▲

      the send_code_attempts/items/ response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ▲

      the sna response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ○

      the ChannelConfiguration request property type/format was generalized from object/ to /

      request-property-type-generalized

    • ○

      the RateLimits request property type/format was generalized from object/ to /

      request-property-type-generalized

  • v243e0e113369c5See the full diff
    • ▲

      the ChannelConfiguration request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the RateLimits request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the lookup response's property type/format changed from / to object/ for status 201

      response-property-type-changed

    • ▲

      the send_code_attempts/items/ response's property type/format changed from / to object/ for status 201

      response-property-type-changed

    • ▲

      the sna response's property type/format changed from / to object/ for status 201

      response-property-type-changed

  • v23c259d635af31See the full diff
    • ○

      added the new optional request property EnableSnaClientToken

      new-optional-request-property

  • v2e2dd9cab5c111See the full diff
    • ○

      added the new optional request property Tags

      new-optional-request-property

  • v29e41726955fb1See the full diff
    • ●

      removed the request property Tags

      request-property-removed

  • v20b5be80715051See the full diff
    • ○

      added the new optional request property Tags

      new-optional-request-property