CAcardda
Company membership

Update a company membership

Updates a membership's KYC attributes (legal_representative, has_powers_to_act, partner, partner_type, participation_rate, is_indirect_participation_corporate). While the company's verification_status is pending/rejected, the KYC file fields (identification_file, power_file, pep_file, pep_file_template) are also writable. role is writable only by callers holding the members_management permission.

patch/v1/company_memberships/{id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/company_memberships/{id}
  • Auth
    HTTP bearer

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

rolestring

Requires the members_management permission.

legal_representativeboolean
has_powers_to_actboolean
partnerboolean
partner_typeinteger
participation_ratenumber
is_indirect_participation_corporateboolean
identification_filestring
power_filestring
pep_filestring
pep_file_templatestring

Response

The updated membership.

idstring uuid required
user_idstring nullable

Firebase UID of the member. Null while the invitation is still pending.

company_idstring uuid required
emailstring nullable
rolestring

Role name (e.g. owner, admin, member, or a custom company role name).

status'pending' | 'active' | 'canceled'
legal_representativeboolean
has_powers_to_actboolean nullable
partnerboolean
partner_typeinteger nullable
participation_ratenumber nullable

Ownership participation percentage (0-100).

is_indirect_participation_corporateboolean nullable
company_role_idstring uuid nullable
created_atstring date-time
updated_atstring date-time

Example response

{
  "role": "member",
  "status": "active"
}

Changes

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