Customers

Update an associated person

Updates an associated person's mutable attributes (roles, ownership percentage, identity block, e-mail). Only included fields are changed, inside individual too: omitted identity fields keep their stored value. Returns the updated AssociatedPerson.

Gender. individual.gender (male, female or other) is recorded with the same rules as the customer portal. The open gender request on the customer closes only when every person who signs for the company has a gender. Once that request is closed, a declared gender is locked: changing it returns 409 GENDER_ALREADY_DECLARED.

Records from onboarding documents. An associated person created from the customer's onboarding documents accepts only individual.gender, individual.phone, email and, when the documents did not bring them, individual.residential_address and individual.date_of_birth through the API; any other field returns 409 LEGACY_RECORD_GENDER_ONLY. The address and the date of birth can only be filled in. An address counts as already on record when it is complete (street, number, neighborhood, city, state and postal code), whether the stored record or the documents hold it; an incomplete one is completed by merging: what is already on record survives and only its blank components are taken from the call. A date of birth counts as soon as one exists. Replacing what is already on record returns 409 LEGACY_RECORD_FIELD_ALREADY_SET, with the first such field in param and all of them in details. The call is refused as a whole and nothing in the body is written, so resend without those fields; the correction itself goes through OZAV support. Send the whole residential_address, not a part of it (a Brazilian one needs a postal code with 8 digits and a 2-letter state). A retry after a lost response may answer 409 LEGACY_RECORD_FIELD_ALREADY_SET because the first call was applied. With gender in the body, a fill that lands between the checks can be refused after the gender was recorded: resend without gender. These records do not return an individual block, the phone or the e-mail, and the other identity fields (legal name, tax id) listed in their requirements.missing_fields are completed through OZAV support, not through this endpoint. For them requirements is computed from a person without an individual block, so it keeps listing individual.phone after you set it; the address, the date of birth and email leave the list once they are set.

Concurrent changes. If the person changes between read and write, the call returns 409 CONCURRENT_UPDATE; retrying the same request is safe.

patch/customers/{customer_id}/associated-persons/{person_id}

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

rolesstring[]

Replacement set of roles - one or more of ubo, director, officer, authorized_signer.

ownership_percentnumber

Revised ownership percentage, 0-100.

emailstring email

Contact e-mail of the person. The institution that opens the account asks for it from every representative of a company. It can be set or replaced here at any time, also on a person created from the onboarding documents (which accepts only email, individual.phone, individual.gender and, when missing, individual.residential_address and individual.date_of_birth).

Response

Updated associated person.

idstring required

Opaque associated-person identifier, prefixed ozav_ap_.

object'associated_person' required

Resource type discriminator; always the literal associated_person.

customer_idstring

The ozav_cus_ id of the business customer this person belongs to.

rolesstring[] required

Roles this person holds - one or more of ubo, director, officer, authorized_signer (see AssociatedPersonCreateRequest.roles).

ownership_percentnumber

Percentage of the business this person owns, 0-100.

emailstring email

Contact email for this person.

created_atstring date-time

When the associated person was added (RFC 3339 / ISO 8601, UTC).

Changes

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