CRcrmcarecloud
One Time Password

Verify a one-time password

Verifies a one-time password. The password must be submitted within 1 hour of being sent and can only be used once. Use the request ID returned by POST /one-time-password/actions/send together with the verification code received by the recipient.

post/one-time-password/actions/verify

Request

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

verification_codestring required

Verification code from email, SMS or notification provided by recipient.

request_idstring required

The parameter specifies the request that caused the OTP to be created. The request ID is returned by POST /one-time-password/actions/send.

external_application_idstring required

The unique ID of the external application that requested the one-time password. If you do not have an external application ID, see the authentication documentation.

Example request

{
  "verification_code": "7256",
  "request_id": "106c5ce60ed0830ffb813135bfff7cad9f4c3e47",
  "external_application_id": "82de12eb8b138791e678fd11c3"
}

Response

OK

Example response

{
  "data": {
    "is_valid": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.