Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
One Time Password

Send a one-time password to a communication channel.

Sends a one-time password to the selected communication channel and returns a request ID used for verification. The password is valid for 1 hour by default and can only be used once. Use the request ID with POST /one-time-password/actions/verify to complete verification.

post/one-time-password/actions/send

Headers

Accept-Languagestring

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

Request body

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.

communication_channel_id1 | 2 | 4 | 5 required

The unique ID of the communication channel. Possible values: 1 - email, 2 - SMS, 4 - push notification (Apple or Google), 5 - internal system notification.

recipientstring required

Recipient of the message with OTP. The parameter could contain email, phone number or other identifier of the message recipient.

otp_type1 | 2

Sets the OTP type to generate. Possible values: 1 - alphanumeric, 2 - numeric.

message_template_idstring

The unique ID of the message template. If not set, CareCloud uses the default value from the system configuration.

Example request

{
  "external_application_id": "82de12eb8b138791e678fd11c3",
  "communication_channel_id": 1,
  "recipient": "happy_customer@crmcarecloud.com",
  "otp_type": 2
}

Response

OK

Example response

{
  "data": {
    "request_id": "c27c29917a1dec03ef0673d823619b776ab93353"
  }
}