Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
User

Retrieve a user

Returns a single user by id (the Firebase UID). A normal user can only fetch their own record; Cardda staff can fetch any. Includes the user's memberships and computed profile methods. This endpoint is not company-scoped (it is on the company-id header whitelist).

get/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.

Response

The requested 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"
}