Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Services

A Verification Service is the set of common configurations used to create and check verifications. You can create a service with the API or in the Console. This includes features like:

  • Friendly Name (used in the Verification message templates)
  • Code Length
  • Skip sending SMS to Landlines
  • Requiring DTMF Input for Voice Verifications
  • Enabling Twilio Lookup

The example below shows different friendly names and code lengths used in our message templates.

sms example friendly name and code length

Service Response Properties

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

Names in py format
sid
sid<VA> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the Service resource.

friendly_name
string Not PII

The string that you assigned to describe the verification service. This value should not contain PII.

code_length
integer Not PII

The length of the verification code to generate.

lookup_enabled
boolean Not PII

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

psd2_enabled
boolean Not PII

Whether to pass PSD2 transaction parameters when starting a verification.

skip_sms_to_landlines
boolean Not PII

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

dtmf_input_required
boolean Not PII

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

tts_name
string Not PII

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

date_created
date_time<iso8601> Not PII

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

date_updated
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 resource.

links
uri_map Not PII

The URLs of related resources.

Create a Verification Service

post
https://verify.twilio.com/v2/Services

These are the available input parameters for creating a Service.

Parameters
Names in None format
friendly_name
Required
post string Not PII

A descriptive string that you create to describe the verification service. It can be up to 64 characters long. This value should not contain PII.

code_length
Optional
post integer Not PII

The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.

lookup_enabled
Optional
post boolean Not PII

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

skip_sms_to_landlines
Optional
post boolean Not PII

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

dtmf_input_required
Optional
post boolean Not PII

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

tts_name
Optional
post string Not PII

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

psd2_enabled
Optional
post boolean Not PII

Whether to pass PSD2 transaction parameters when starting a verification.

Example 1
        
        
        
        
        Example 2
              
              
              
              

              See Verifying Transactions for PSD2 for more information.

              Fetch a Service

              get
              https://verify.twilio.com/v2/Services/{Sid}
              Parameters
              Names in None format
              sid
              Required
              get sid<VA> Not PII

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

              Example 1
                    
                    
                    
                    

                    List all Services

                    get
                    https://verify.twilio.com/v2/Services
                    Example 1
                          
                          
                          
                          

                          Update a Service

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

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

                          Parameters
                          Names in None format
                          sid
                          Required
                          post sid<VA> Not PII

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

                          friendly_name
                          Optional
                          post string Not PII

                          A descriptive string that you create to describe the verification service. It can be up to 64 characters long. This value should not contain PII.

                          code_length
                          Optional
                          post integer Not PII

                          The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.

                          lookup_enabled
                          Optional
                          post boolean Not PII

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

                          skip_sms_to_landlines
                          Optional
                          post boolean Not PII

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

                          dtmf_input_required
                          Optional
                          post boolean Not PII

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

                          tts_name
                          Optional
                          post string Not PII

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

                          psd2_enabled
                          Optional
                          post boolean Not PII

                          Whether to pass PSD2 transaction parameters when starting a verification.

                          Example 1
                                
                                
                                
                                
                                Example 2
                                      
                                      
                                      
                                      

                                      Delete a Service

                                      delete
                                      https://verify.twilio.com/v2/Services/{Sid}
                                      Parameters
                                      Names in None format
                                      sid
                                      Required
                                      delete sid<VA> Not PII

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

                                      Example 1
                                            
                                            
                                            
                                            
                                            Rate this page:

                                            Need some help?

                                            We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.