v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Validation of the customer data

Validate customer data following CareCloud validation standards. Supports validation of passwords and referral codes.

Validation types

password - validates that the value meets the CareCloud password strength requirements. Call this before POST /customers to verify the proposed password.
referral_code - validates that the value is an existing, active referral code for a valid referral campaign. Call this before POST /customers to confirm a referral code is valid before attempting registration. This endpoint does not create or generate referral codes; it only validates an existing one.

This endpoint does not require authentication.

post/customers/actions/validate-customer-data

type'password' | 'referral_code' required

Type of the customer data to validate. Possible values:

password - validates the value against CareCloud password strength requirements.
referral_code - validates that the value is an existing, active referral code.

valuestring required

Value of the customer data to validate. For password, provide the proposed password. For referral_code, provide the referral code string.

{
  "type": "password",
  "value": "neGIecAcu#Tawp0b@Kir"
}

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