github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesVerificationsApi.md (about)

     1  # ServicesVerificationsApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateVerification**](ServicesVerificationsApi.md#CreateVerification) | **Post** /v2/Services/{ServiceSid}/Verifications | 
     8  [**FetchVerification**](ServicesVerificationsApi.md#FetchVerification) | **Get** /v2/Services/{ServiceSid}/Verifications/{Sid} | 
     9  [**UpdateVerification**](ServicesVerificationsApi.md#UpdateVerification) | **Post** /v2/Services/{ServiceSid}/Verifications/{Sid} | 
    10  
    11  
    12  
    13  ## CreateVerification
    14  
    15  > VerifyV2Verification CreateVerification(ctx, ServiceSidoptional)
    16  
    17  
    18  
    19  Create a new Verification using a Service
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **ServiceSid** | **string** | The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a CreateVerificationParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  **To** | **string** | The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
    37  **Channel** | **string** | The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.
    38  **CustomFriendlyName** | **string** | A custom user defined friendly name that overwrites the existing one in the verification message
    39  **CustomMessage** | **string** | The text of a custom message to use for the verification.
    40  **SendDigits** | **string** | 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](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
    41  **Locale** | **string** | Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See supported languages and more information here](https://www.twilio.com/docs/verify/supported-languages).
    42  **CustomCode** | **string** | A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
    43  **Amount** | **string** | The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
    44  **Payee** | **string** | The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
    45  **RateLimits** | [**interface{}**](interface{}.md) | The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
    46  **ChannelConfiguration** | [**interface{}**](interface{}.md) | [`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.
    47  **AppHash** | **string** | Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
    48  **TemplateSid** | **string** | The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only.
    49  **TemplateCustomSubstitutions** | **string** | A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.
    50  **DeviceIp** | **string** | Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.
    51  **RiskCheck** | **string** | 
    52  **Tags** | **string** | A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.
    53  
    54  ### Return type
    55  
    56  [**VerifyV2Verification**](VerifyV2Verification.md)
    57  
    58  ### Authorization
    59  
    60  [accountSid_authToken](../README.md#accountSid_authToken)
    61  
    62  ### HTTP request headers
    63  
    64  - **Content-Type**: application/x-www-form-urlencoded
    65  - **Accept**: application/json
    66  
    67  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    68  [[Back to Model list]](../README.md#documentation-for-models)
    69  [[Back to README]](../README.md)
    70  
    71  
    72  ## FetchVerification
    73  
    74  > VerifyV2Verification FetchVerification(ctx, ServiceSidSid)
    75  
    76  
    77  
    78  Fetch a specific Verification
    79  
    80  ### Path Parameters
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    86  **ServiceSid** | **string** | The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource from.
    87  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Verification resource to fetch.
    88  
    89  ### Other Parameters
    90  
    91  Other parameters are passed through a pointer to a FetchVerificationParams struct
    92  
    93  
    94  Name | Type | Description
    95  ------------- | ------------- | -------------
    96  
    97  ### Return type
    98  
    99  [**VerifyV2Verification**](VerifyV2Verification.md)
   100  
   101  ### Authorization
   102  
   103  [accountSid_authToken](../README.md#accountSid_authToken)
   104  
   105  ### HTTP request headers
   106  
   107  - **Content-Type**: Not defined
   108  - **Accept**: application/json
   109  
   110  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   111  [[Back to Model list]](../README.md#documentation-for-models)
   112  [[Back to README]](../README.md)
   113  
   114  
   115  ## UpdateVerification
   116  
   117  > VerifyV2Verification UpdateVerification(ctx, ServiceSidSidoptional)
   118  
   119  
   120  
   121  Update a Verification status
   122  
   123  ### Path Parameters
   124  
   125  
   126  Name | Type | Description
   127  ------------- | ------------- | -------------
   128  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   129  **ServiceSid** | **string** | The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to update the resource from.
   130  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Verification resource to update.
   131  
   132  ### Other Parameters
   133  
   134  Other parameters are passed through a pointer to a UpdateVerificationParams struct
   135  
   136  
   137  Name | Type | Description
   138  ------------- | ------------- | -------------
   139  **Status** | **string** | 
   140  
   141  ### Return type
   142  
   143  [**VerifyV2Verification**](VerifyV2Verification.md)
   144  
   145  ### Authorization
   146  
   147  [accountSid_authToken](../README.md#accountSid_authToken)
   148  
   149  ### HTTP request headers
   150  
   151  - **Content-Type**: application/x-www-form-urlencoded
   152  - **Accept**: application/json
   153  
   154  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   155  [[Back to Model list]](../README.md#documentation-for-models)
   156  [[Back to README]](../README.md)
   157