Skip to main content

Get Shareholder by ID

GET 
/v1/users/shareholders/:id

Tag: api-baas-get-by-id-shareholder

Description: Retrieve a shareholder by its unique identifier.

Request​

Path Parameters

    id stringrequired

    Shareholder 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

    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​

The shareholder returned successfully.

Schema
    id stringrequired

    Shareholder ID.

    document stringrequired

    Document number (CPF or CNPJ).

    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type (natural person or legal person).

    name stringrequired

    Shareholder name.

    participation_percentage number

    Participation percentage in legal person 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.

Loading...