List OTP Templates
  • 16 Feb 2024
  • 1 Minute to read

    List OTP Templates


      Article Summary

      Overview

      The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. 

      After you create a channel for your brand, you can list its templates later.

      Endpoint and Headers

      GET https://verify.useinsider.com/v1/template/list

      Headers

      HeaderSample ValueDescription
      X-INS-AUTH-KEY1a2b3c4d5e6fThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
      Content-Typeapplication/jsonThis header specifies the media type of the resource.

      Body Parameters

      ParameterDescriptionData TypeRequiredRules
      channelChannel that you will send the OTP code.StringYesoneof:sms
      brandNameYour brand name defines your OTP SMS content in pre-defined templates.StringYesmin:3 max:30 characters

      Sample Example

      Sample Request

      Every request made to the request endpoint requires a request body formatted in JSON and containing your parameters. 

      Your title goes here
      Make sure to replace the sample values in the request header(s) and body where required before sending your request.
      curl --location 'verify.useinsider.com/v1/template/list' \
      --header 'Content-Type: application/json' \
      --header 'x-ins-auth-key: 1a2b3c4d5e6f'

      Sample Responses

      200 OK

      This response indicates that your request was successfully completed.

      {
          "templates": {
              "sms": [
                  {
                      "locale": "de",
                      "text": "Ihr {brandName} Bestätigungscode lautet: {code}"
                  },
                  {
                      "locale": "en",
                      "text": "Your {brandName} verification code is: {code}"
                  },
                  {
                      "locale": "es",
                      "text": "Su código de verificación de {brandName} es: {code}"
                  },
                  {
                      "locale": "fr",
                      "text": "Votre code de vérification {brandName} est: {code}"
                  },
                  {
                      "locale": "it",
                      "text": "Il tuo codice di verifica {brandName} è: {code}"
                  },
                  {
                      "locale": "ja",
                      "text": "あなたの{brandName}確認コードは: {code}です"
                  },
                  {
                      "locale": "nl",
                      "text": "Uw {brandName} verificatiecode is: {code}"
                  },
                  {
                      "locale": "pt",
                      "text": "Seu código de verificação {brandName} é: {code}"
                  },
                  {
                      "locale": "ru",
                      "text": "Ваш проверочный код {brandName}: {code}"
                  },
                  {
                      "locale": "tr",
                      "text": "{brandName} doğrulama kodunuz: {code}"
                  }
              ]
          }
      }

      401 Unauthorized

      {
          "errors": [
              {
                  "message": "unauthorized"
              }
          ]
      }

      429 Too Many Requests

      {
          "errors": [
              {
                  "message": "rate limit exceeded"
              }
          ]
      }

      Limitations

      • All functions must be executed with a simple HTTPS GET request.
      • The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.

      Was this article helpful?


      ESC

      Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses