Send OTP

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

To complete a staff account creation, you (admin users) need to validate the mobile number and email id through OTP sent to the registered identifiers to complete the account creation.

Query parameter

ParameterDescription
otpPurpose of the OTP validation.

Body parameter

ParameterDescription
idUnique id of the staff.
usernameRegistered username of the staff.
mobileRegistered mobile number of the staff to send OTP. You can use this to validate your mobile number and also to authenticate your login.
emailRegistered email id of the staff to send OTP. You can use this to validate email id and also to authenticate login.

Response parameter

ParameterDescription
entityAn identifier or ID related to a specific entity in the system.
warningsA list containing any warnings related to the operation or request.
errorsA list containing any errors related to the operation or request.
successIndicates whether the operation or request was successful.
Query Params
string
enum
required

Purpose of the OTP validation.

Allowed:
Body Params
int64
required

Unique id of the staff.

string
required

Registered username of the staff.

string

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

string

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

Headers
string
required

Authentication key of the admin.

string
required

ID of the org to associate with the staff user.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json