API Reference

Validation of the customer data

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/actions/validate-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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
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.
Allowed:
string
required

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

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.

Updated 3 days ago

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

Updated 3 days ago