v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Send OTP

Lets admin users to create a staff account for the organization.

post/staff/sendOtp

otp'VALIDATE_EMAIL' | 'LOGIN' | 'VALIDATE_MOBILE' required

Purpose of the OTP validation.

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 of 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.

200

entityinteger

successboolean

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