Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Change Identifier (Validate OTP)

Lets you validate the OTP sent through /changeidentifier/sendotp API to change the identifier of a staff.

Changing identifier is a two step process -

  1. Send OTP to the new identifier (previous API)
  2. Validate the OTP received to the new identifier. (current API)
post/staff/changeidentifier

Headers

X-CAP-API-AUTH-KEYstring

Authentication key of the admin.

X-CAP-API-AUTH-ORG-IDstring

ID of the org to associate with the staff user.

Request body

identifierinteger

Unique id created for the staff

type'mobile' | 'email'

Identifier type used for OTP validation.

notesstring

Reason for identifier change.

otpstring

OTP sent to the registered identifier.

Response

200

entityinteger
successboolean

Example response

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