Skip to main content

Update legal representative

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

Update a legal representative information.

Request​

Path Parameters

    id stringrequired

    Legal representative ID.

Header Parameters

    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
    full_name string

    Legal representative full name.

    income number

    Income in cents.

    patrimony number

    Patrimony in cents.

    participation_percentage number

    Participation percentage (0 to 100).

    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.

    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 neighborhood.

    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.

Loading...