v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Validate OTP

Lets you authenticate customer by validating the OTP sent to the customer through SMS or email and proceed with the necessary action such as redeeming points/coupons, and registering customer.

In Response, entity: true indicates the OTP validation is successful, and "entiry": false if the validation fails.

post/otp/validate

Request body

entityType'MOBILE' | 'EMAIL' required

Specify MOBILE to validate OTP send to the registered mobile number, EMAIL to send the validation code to the registered email ID.

entityValuestring required

Specify the registered mobile number or email id of the customer based on the entityType passed.

codestring required

Validation code received by the customer.

action'COUPON (for coupon redemption)' | 'POINTS (for points redemption)' | 'REGISTRATION' | 'USERGROUP' | 'SUBSCRIPTION' | 'GENERIC (for other purposes)' | 'CUSTOMER_IDENTIFIER_CHANGE' | 'CUSTOMER_STATUS_UPDATE' | 'CUSTOMER_ISSUE_LINK_CARD.' required

Action to be performed on successful validation.

Response

200

entityboolean

Example response

{
  "entity": true
}