Skip to main content

Get all legal representatives

GET 
/v2/users/legal-representatives

Get all legal representatives linked to the authenticated legal person and its shareholders.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

Legal representatives returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Legal representatives data.

  • Array [
    • 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...