v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

User

Update a user

Updates the user's profile. user_type and identifier cannot be changed once set (unless by staff). email is writable only by the owner of the record; a range of financial/role attributes is writable only by Cardda staff. An optional nested company object can create or update the user's owned company. Not company-scoped (self-service, on the whitelist).

patch/v1/users/{id}

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Request body

first_namestring

last_namestring

phoneinteger

identifierstring

Immutable once set (for non-staff).

user_typestring

Cannot be changed once set (unless by Cardda staff).

emailstring email

Writable only by the owner of the record.

countrystring

nationalitystring

addressstring

occupationstring

genderinteger

is_pepboolean

birthdatestring date-time

terms_acceptedboolean

legal_addressobject

companyobject

Optional nested company create/update for the user's owned company.

Example request

{
  "user_type": "business"
}

Response

The updated user.

idstring required

Firebase UID.

first_namestring nullable

last_namestring nullable

emailstring nullable

phoneinteger nullable

identifierstring nullable

Tax id / national id of the user.

countrystring nullable

nationalitystring nullable

addressstring nullable

occupationstring nullable

genderinteger nullable

birthdatestring date-time nullable

is_pepboolean

Whether the user is a politically exposed person.

legal_addressobject nullable

user_typestring nullable

statusstring

terms_acceptedboolean

legal_representativeboolean nullable

has_powers_to_actboolean nullable

whatsapp_verifiedboolean

milestone_idsstring[]

Computed list of milestone ids reached by the user.

n_companiesinteger

Number of companies the user belongs to (computed).

company_rolestring nullable

The user's role in the current company context (computed).

plh_profile_completeboolean

Whether the user's PLH profile is complete (computed; serialized as plh_profile_complete?).

missing_plh_profile_fieldsstring[]

needs_password_setupboolean

Whether the user still needs to set a password (computed; serialized as needs_password_setup?).

created_atstring date-time

updated_atstring date-time

Example response

{
  "user_type": "business",
  "status": "pending"
}