v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Validate OTP

Lets admin users validate OTP sent to the staff’s registered mobile number or email id through the staff/sendOtp API.

post/staff/validate

X-CAP-API-AUTH-KEYstring required

Authentication key of the admin.

X-CAP-API-AUTH-ORG-IDstring required

ID of the org to associate with the staff user.

idinteger required

Unique id created for the staff

usernamestring required

Registered username of the staff.

mobilestring

Registered mobile number of the staff to send OTP. You can use this to validate mobile number and also to authenticate login.

emailstring

Registered email id of the staff to send OTP. You can use this to validate email id and also to authenticate login.

identifierType'EMAIL' | 'MOBILE' required

Specify EMAIL for email id validation and MOBILE for mobile number validation.

passwordstring required

The password of the staff account.

otpstring required

One time password received on the specified identifierType.

200

entityinteger

successboolean

{
  "entity": 75025586,
  "success": true
}