Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Tokens

Login via authentication token

Log in the customer using the provided authentication token for a seamless and secure login experience. The authentication token can be provided in the method GET /tokens/{token_id}/actions/auth-token ⚠️ Endpoint is available only in Customer interface.

post/tokens/{token_id}/actions/authentication-token-login

Path parameters

token_idstring required

A client application token.

Headers

Accept-Languagestring

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

Request body

application_idstring required

ID of the destination external application. Please provide the destination external application ID, not the token-issuing external application ID. Need a destination external application ID? Please contact your CareCloud administrator.

tokenstring required

Authentication token

token_request_idstring required

The parameter specifies the request that caused the token to be created. If two customers generated an authentication token at the same time and in the same application, the token_request_id parameter represents doubled verification to identify the correct token. In case you dont need to have two factor authentication, please send both parameters (token and token_request_id) one way. For example in HTTP Authentication header.

Example request

{
  "application_id": "82de12eb8b138791e678fd11c3",
  "token": "V952TL",
  "token_request_id": "702baa4a40a57694831321e5d02605d46c189369126ae43a81030790ea188af87e49578a"
}

Response

OK

Example response

{
  "data": {
    "customer_id": "8ea6abece4cd0a4ded0a29f093"
  }
}