CAcardda
User

Create a user

Creates the authenticated Firebase user's Cardda account. The identity (id and email) is taken from the verified Firebase ID token — not from the body. This endpoint authenticates via a Firebase ID token (the normal bearer session is skipped); the token is supplied in the Authorization header. Optional pomelo_user details provision a Pomelo (Mexico) card user; if that provisioning fails a 400 is returned.

post/v1/users

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/users
  • Auth
    API key in header Authorization

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Request body

first_namestring
last_namestring
identifierstring
phoneinteger
countrystring
nationalitystring
addressstring
occupationstring
terms_acceptedboolean
user_typestring

Example request

{
  "user_type": "business"
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.