Sign in
VerifyV2Service

Update a specific Verification Service.

Update a specific Verification Service.

post/v2/Services/{Sid}

Path parameters

Sidstring required

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

Response

OK

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Service resource.

friendly_namestring nullable

The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. It cannot contain more than 4 (consecutive or non-consecutive) digits. This value should not contain PII.

code_lengthinteger

The length of the verification code to generate.

lookup_enabledboolean nullable

Whether to perform a lookup with each verification started and return info about the phone number.

psd2_enabledboolean nullable

Whether to pass PSD2 transaction parameters when starting a verification.

skip_sms_to_landlinesboolean nullable

Whether to skip sending SMS verifications to landlines. Requires lookup_enabled.

dtmf_input_requiredboolean nullable

Whether to ask the user to press a number before delivering the verify code in a phone call.

tts_namestring nullable

The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.

do_not_share_warning_enabledboolean nullable

Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code

custom_code_enabledboolean nullable

Whether to allow sending verifications with a custom code instead of a randomly generated one.

{"stackTrail":"components:schemas:verify.v2.service:properties:push","oasType":"schema","type":"unknown","description":"Configurations for the Push factors (channel) created under this Service.","nullable":true}
{"stackTrail":"components:schemas:verify.v2.service:properties:totp","oasType":"schema","type":"unknown","description":"Configurations for the TOTP factors (channel) created under this Service.","nullable":true}
default_template_sidstring nullable
{"stackTrail":"components:schemas:verify.v2.service:properties:whatsapp","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:verify.v2.service:properties:passkeys","oasType":"schema","type":"unknown","nullable":true}
verify_event_subscription_enabledboolean nullable

Whether to allow verifications from the service to reach the stream-events sinks if configured

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.

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of related resources.

Changes

Changed in 11 of the 52 revisions of this API.6217

  • 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

  • v2b99dcc113b963See the full diff
    • ○

      added the new optional request property Passkeys.AuthenticatorAttachment

      new-optional-request-property

    • ○

      added the new optional request property Passkeys.DiscoverableCredentials

      new-optional-request-property

    • ○

      added the new optional request property Passkeys.UserVerification

      new-optional-request-property

  • v23fd4376faab54See the full diff
    • ○

      added the new optional request property Passkeys.RelyingParty.Id

      new-optional-request-property

    • ○

      added the new optional request property Passkeys.RelyingParty.Name

      new-optional-request-property

    • ○

      added the new optional request property Passkeys.RelyingParty.Origins

      new-optional-request-property

    • ○

      added the optional property passkeys to the response with the 200 status

      response-optional-property-added

  • v21548692e68043See the full diff
    • ▲

      the push response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the totp response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the whatsapp response's property type/format changed from object/ to / for status 200

      response-property-type-changed

  • v243e0e113369c3See the full diff
    • ▲

      the push response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the totp response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the whatsapp response's property type/format changed from / to object/ for status 200

      response-property-type-changed

  • v2c6432fdfc1a21See the full diff
    • ○

      the code_length response's property default value 0 was added for the status 200

      response-property-default-value-added

  • v22fc124eb9d5c3See the full diff
    • ○

      added the new optional request property Whatsapp.From

      new-optional-request-property

    • ○

      added the new optional request property Whatsapp.MsgServiceSid

      new-optional-request-property

    • ○

      added the optional property whatsapp to the response with the 200 status

      response-optional-property-added

  • v2e2dd9cab5c112See the full diff
    • ○

      added the new optional request property VerifyEventSubscriptionEnabled

      new-optional-request-property

    • ○

      added the optional property verify_event_subscription_enabled to the response with the 200 status

      response-optional-property-added

  • v29e41726955fb2See the full diff
    • ●

      removed the request property VerifyEventSubscriptionEnabled

      request-property-removed

    • ●

      removed the optional property verify_event_subscription_enabled from the response with the 200 status

      response-optional-property-removed

  • v2b965728c225d2See the full diff
    • ○

      added the new optional request property VerifyEventSubscriptionEnabled

      new-optional-request-property

    • ○

      added the optional property verify_event_subscription_enabled to the response with the 200 status

      response-optional-property-added