Customer's credentials verification

Verification of a customer account credentials.

Validates a customer's login credentials (email address and password) against their CareCloud account. Returns the customer ID if the credentials are valid. Use this endpoint to authenticate a customer before granting access to a service or application.

⚠️ Action method for verification credentials is available only in the Enterprise interface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The unique ID of the login type (available: card, email).

Allowed:
string
required

Value of the login for customer interface API.

password
required

Password of the customer.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

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