Skip to main content

List Shareholders

GET 
/v1/users/shareholders
Tag: api-baas-get-all-shareholderDescription: Retrieve a list of shareholders for the authenticated legal person account.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    page_size number

    Default value: 20

    Page size.

    sort string

    Possible values: [created_at]

    Default value: created_at

    Page sort.

    order string

    Possible values: [asc, desc]

    Default value: desc

    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

    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.

Responses​

The shareholders returned successfully.

Schema
    data object[]required

    Shareholders data.

  • Array [
    • id stringrequired

    Shareholder ID.

    document stringrequired

    Document number (CPF or CNPJ).

    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type (PF or PJ).

    name stringrequired

    Shareholder name.

    participation_percentage number

    Participation percentage in company capital.

    type stringrequired

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

    Shareholder type/qualification.

    zip_code string

    Zip code (CEP) of the shareholder address.

    created_at date-timerequired

    Creation date.

  • ]
    • page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    total numberrequired

    Total records.

    page_total numberrequired

    Total pages.

Loading...