v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Check ability to register a customer

Check ability to register a customer with his identifier (email or phone number).

Determines whether the given identifier is available for new customer registration - for example, whether it is already associated with an existing account. Use this endpoint before submitting a registration form to provide early feedback to the user.

⚠️ For use in the Customer interface integration (mobile application, web portal, or kiosk), this action method has to be allowed in CareCloud. Please contact the CareCloud administrator.

post/customers/actions/check-registration-ability

Request body

type'email' | 'phone' required

Type of the customer identifier. Phone numbers can be checked only if the phone is unique in the CareCloud project.

valuestring required

Value of the customer identifier.

Example request

{
  "type": "email",
  "value": "example@crmcarecloud.com"
}

Response

Example response

{
  "data": {
    "registration_ability": true
  }
}