Sign in
Company

Update a company

Updates a company. The set of writable attributes depends on the caller's role and the company's verification_status:

  • Company owners/admins can update name, address, interests, referral fields, and (while KYC is pending/rejected/unset) the KYC document and profile fields (fantasy_name, commercial_business, contact_phone, contact_email, commercial_type, constitution_date, legal_address, economic_activities, and the KYC file fields).
  • Once verification_status is approved, only the signed-contract flags (plh_contract_file_signed, plh_kyc_file_signed, plh_alliance_file_signed) remain writable by company users.
  • Members can also submit nested company_memberships updates (role, legal representative, powers, partner, participation rate).
  • A large set of commercial/financial attributes is writable only by Cardda staff and is intentionally omitted here.

Non-privileged callers receive an empty permitted set (no-op update).

patch/v1/companies/{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.

Parameters

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

Request body

namestring
addressstring
fantasy_namestring
commercial_businessstring
contact_phonestring
contact_emailstring
commercial_typeinteger
constitution_datestring date-time
purpose_to_use_cardsstring
interestsstring[]
economic_activitiesobject[]
referral_approvedboolean
referrer_idstring uuid
plh_contract_file_signedboolean

Writable only when verification_status is approved.

plh_kyc_file_signedboolean

Writable only when verification_status is approved.

plh_alliance_file_signedboolean

Writable only when verification_status is approved.

Response

The updated company.

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