Verify Templates are in Pilot
This Verify feature is currently in the Pilot maturity stage, which means that:
1. We're actively looking for early-adopter customers to try it out and give feedback. That could be you!
2. You'll need to contact sales to request access to the API.
Lastly, please note that templates are only supported with the SMS channel.
Templates are predefined and approved texts used to send a SMS Verification. Templates allow you to customize the text you send for verification.
Template types include:
|Public||Available for all Verify customers. More information and a list of public template text options found here.|
|Private||Available on a case by case basis per customer. Please get in touch if one of our public templates does not suit your business need.|
An account can have multiple public and private templates associated with it to accomodate various use cases like:
- user authentication
- account validation
- password reset
- ...and more!
The template message body can be translated to various languages with the
locale parameter. Learn more about support languages here.
|Resource Properties in REST API format|
A 34 character string that uniquely identifies a Verification Template.
The unique SID identifier of the Account.
A descriptive string that you create to describe a Template.
An object that contains the different translations of the template. Every translation is identified by the language short name and contains it respective information as the approval status, text and created/modified date.
|Parameters in REST API format|
String filter used to query templates with a given friendly name
The message template used for an SMS verification is defined with the following priority order:
To send a verification with a specified template, include the TemplateSid (starts with HJ) as a parameter.
You can also define a default message template for a Service that will be used for all SMS verifications (unless you explicitly override it).
DefaultTemplateSid attribute of the service can be set both when the Service is created or when the Service is updated.
If neither a
TemplateSid is provided when starting a new Verification nor a
DefaultTemplateSid attribute is set for the Service, the Verification will use the default translation for that template.
More details on how to start a Verification can be found in the Verification documentation.