👍

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

🚧

Warning

Make sure that the OTP template does not have multiple placeholders for the OTP. This can lead to displaying OTP in all placeholders.

This API enables the issuing of validation code (OTP) to the defined communication channel for redeeming points/coupons, and registration.

Prerequisites

• Basic or OAuth credentials
• OTP access group resource with WRITE access
• Make sure that the template contains a placeholder for OTP and that the appropriate templates are approved.
• Make sure that you have configured appropriate OTP configurations as required. For more information, refer to the OTP configuration documentation.
• Make sure that the channel gateway configuration is completed. For the configuration, create a JIRA ticket for the gateway team.
• Make sure that the appropriate OTP template is configured and approved. For more information on the OTP template, refer to the OTP template documentation.

Resource information

OTP template selection hierarchy

First preference - OTP template defined in the API body

Second preference - The default template

Third preference - If no template is configured and the template field is left blank, the system uses the inbuilt Capillary template.

Request body parameters

📘

Notes

• If the email template is not specified, the OTP will be sent in the default email template format specified below: “emailTemplate”:{ “subject”:“Validation Code”, “body”:“Dear Customer, The validation code for your request is: {{ validation_code }}. You will also receive the validation code by SMS on your registered mobile number shortly.” },
• If SMS template is not specified, the OTP will be sent in the SMS format "Hi user.Your otp for validation is {{ validation_code }}."

{
   "entityType":"email",
   "entityValue":"[email protected]",
   "action":"REGISTRATION",
   "template":"Hi user.Your OTP for validation is {{ validation_code }}.Enjoy",
   "emailTemplate":{
      "subject":"Validation Code",
      "body":"Dear Customer, The validation code for your request is: {{ validation_code }}. You will also receive the validation code by SMS on your registered mobile number shortly."
   },
   "channels":[
      {
         "type":"SMS",
         "value":"9191919191"
      },
      {
         "type":"EMAIL",
         "value":"[email protected]"
      },
      {
         "type":"PHONE",
         "value":"9191919191"
      }
   ]
}

{
  "entityType": "mobile",
  "entityValue": "919986000581",
  "action": "POINTS",
   "whatsappTemplateName": "test_temp2",
  "channels": [
    {
      "type": "whatsapp",
      "value": "919986000586"
    }
    
  ]
}

{
   "entityType":"MOBILE",
   "entityValue":"911234567896",
   "action":"POINTSTRANSFER",
   "template":"Hi user.Your OTP for validation is {{ validation_code }}.Enjoy",
   "channels":[
      {
         "type":"SMS",
         "value":"911234567896"
      },
      {
         "type":"PHONE",
         "value":"911234567896"
      }

Response

{
    "createdId": 10,
    "warnings": []
}

📘

Note

If the OTPs are regenerated within the OTP expiry limit, the same OTP is generated again, and the createdId value appears as 1.

Error codes