Skip to main content

Update legal representative

PUT 
/v2/users/legal-representatives/:id

Update a legal representative information. You can optionally link, relink, or unlink the representative from a shareholder.

Shareholder linking options:

  • Link to a shareholder: Provide shareholder_id with a valid UUID
  • Relink to a different shareholder: Provide a different shareholder_id
  • Unlink from shareholder: Omit shareholder_id completely from the request body (if currently linked)

Important notes:

  • The shareholder_id must belong to the same company (same authenticated user)
  • If the legal representative is currently linked to a shareholder and you want to unlink, simply omit shareholder_id from the request body
  • All other fields are optional and will only update if provided
  • At least one contact method (email or phone) must remain after update
  • If you only want to update the shareholder link, you can send a minimal request with just shareholder_id

Request​

Path Parameters

    id stringrequired

    Legal representative ID.

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    name string

    Legal representative name.

    mother_name string

    Mother name.

    income number

    Income in cents.

    patrimony number

    Patrimony in cents.

    participation_percentage number

    Participation percentage in management/representation (0 to 100).

    Note: This represents the legal representative's participation in company management, which may differ from their equity stake. If this legal representative is linked to a shareholder, the shareholder has its own participation_percentage representing equity stake.

    pep boolean

    PEP self-declaration.

    representor_type string

    Possible values: [PARTNER, ATTORNEY, ADMINISTRATOR, OTHER]

    Legal representative qualification.

    phone_number string

    Phone number.

    email string

    Email.

    relationship_start_date date-time

    Relationship start date with the legal entity.

    relationship_end_date date-time

    Relationship end date with the legal entity.

    shareholder_id string

    Shareholder ID to link this legal representative to. Must belong to the same company.

    Usage:

    • Link: Provide a valid shareholder UUID to link the representative
    • Relink: Provide a different shareholder UUID to change the link
    • Unlink: Omit this field completely to remove the shareholder link (if currently linked)

    Note: The shareholder must be created first via the shareholders endpoint and must belong to the same company.

    To unlink: Simply omit this field from the request body. The system will automatically remove the link if one exists.

    address object
    zip_code stringrequired

    User address zip code.

    street stringrequired

    User address street.

    number numberrequired

    User address number.

    neighborhood string

    User address neighborhood.

    city stringrequired

    User address city.

    federative_unit stringrequired

    User address federative unit.

    country stringrequired

    User address country.

    complement string

    User address complement.

Responses​

Legal representative updated.

Schema
    id stringrequired

    Legal representative ID.

    document objectrequired
    id stringrequired

    Document ID.

    type stringrequired

    Possible values: [CPF]

    Document type.

    number stringrequired

    Document number.

    country_of_issue stringrequired

    Document country of issue.

    address objectrequired
    id stringrequired

    Address ID.

    zip_code stringrequired

    ZIP code.

    street stringrequired

    Street.

    number numberrequired

    Street number.

    neighborhood stringrequired

    Neighborhood.

    city stringrequired

    City.

    federative_unit stringrequired

    Federative unit.

    country stringrequired

    Country.

    complement string

    Address complement.

    name stringrequired

    Legal representative name.

    representor_type stringrequired

    Possible values: [PARTNER, ATTORNEY, ADMINISTRATOR, OTHER]

    Legal representative qualification.

    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type.

    income number

    Income in cents.

    patrimony number

    Patrimony in cents.

    participation_percentage number

    Participation percentage.

    pep booleanrequired

    PEP flag.

    is_public_server booleanrequired

    Public server flag.

    phone_number string

    Phone number.

    email string

    Email.

    registration_update_date date-timerequired

    Registration update date.

    birth_date date-timerequired

    Birth date.

    relationship_start_date date-timerequired

    Relationship start date with the legal entity.

    relationship_end_date date-time

    Relationship end date with the legal entity.

    created_at date-timerequired

    Creation date.

    shareholder_id string

    Shareholder ID this legal representative is linked to.

Loading...