Sign in
Company

List companies

Returns the paginated list of companies the authenticated user belongs to (for Cardda staff, all companies). This is the non-company-scoped discovery endpoint — it does not require the company-id header, because it is exactly how a client discovers which companies (and therefore which company-id values) it may operate on.

Each item is augmented with the computed counters n_users, n_cards, n_virtual_cards and owner_id. The financial balance method is added only for Cardda staff.

Supports the standard list query parameters (_start, _end, _order, _field) plus MongoDB-style filters passed as query params (e.g. identifier, name, verification_status), where each value may be a plain value or a JSON operator object such as {"$in":["..."]}.

get/v1/companies

Query parameters

identifierstring

Filter by company tax id (RUT). Plain value or JSON operator object.

namestring

Filter by company name.

verification_status'pending' | 'awaiting_review' | 'approved' | 'rejected'

Filter by KYC verification status.

Parameters

#/paths/~1v1~1users/get/parameters/1 — unresolved $ref
#/paths/~1v1~1users/get/parameters/2 — unresolved $ref
#/paths/~1v1~1users/get/parameters/3 — unresolved $ref
#/paths/~1v1~1users/get/parameters/4 — unresolved $ref

Response

Paginated list of companies. Includes the list metadata headers.

idstring uuid required
typestring

STI subclass. Always Company for this resource.

identifierstring required

Tax id (RUT in Chile) of the company. Digits plus verification digit.

namestring nullable
fantasy_namestring nullable
countrystring nullable
commercial_businessstring nullable
commercial_typeinteger nullable
addressstring nullable
contact_phonestring nullable
contact_emailstring nullable
constitution_datestring date-time nullable
purpose_to_use_cardsstring nullable
legal_addressobject nullable

Structured legal address (street, number, municipality_id, complement, city).

economic_activitiesobject[] nullable
interestsstring[]
notification_emailsstring[]
rutsobject nullable

Additional RUTs associated with the company.

referral_codestring
referrer_idstring uuid nullable
referral_approvedboolean nullable
collector_account_idstring uuid nullable
preferred_currencystring
verification_status'pending' | 'awaiting_review' | 'approved' | 'rejected'

KYC verification status.

kyc_completedboolean
plh_enabledboolean

Whether the company is enrolled in the PLH card program.

contracts_verifiedboolean
activatedboolean
activeboolean
can_delegate_payablesboolean
n_usersinteger

Number of member users (computed method).

n_cardsinteger

Number of cards (computed method).

n_virtual_cardsinteger

Number of virtual cards (computed method).

owner_idstring uuid nullable

User id of the owner membership (present on the index listing).

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "type": "Company",
    "identifier": "770000001",
    "name": "Mi Empresa SpA",
    "fantasy_name": "Mi Empresa",
    "country": "CL",
    "preferred_currency": "clp",
    "verification_status": "approved"
  }
]

Changes