Skip to main content

Get all Legal person onboarding documents by onboarding ID.

GET 
/v1/users/onboardings/legal-person/:id/documents

Retrieve all documents (doc_id, file_id, type, created_at, updated_at) for a specific onboarding.

Request​

Path Parameters

    id stringrequired

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

Responses​

Documents retrieved successfully.

Schema
    id stringrequired

    Onboarding ID.

    documents object[]required

    List of documents.

  • Array [
    • id stringrequired

    Document ID.

    file_id stringrequired

    File ID.

    type stringrequired

    Possible values: [contrato_social, balanco_patrimonial, declaracao_faturamento, politica_kyc_pld]

    Document type. Possible values: contrato_social,balanco_patrimonial,declaracao_faturamento,politica_kyc_pld

    created_at date-timerequired

    Document creation date.

    updated_at date-timerequired

    Document update date.

  • ]
Loading...