Skip to main content

Update Legal person onboarding document.

PATCH 
/v1/users/onboardings/legal-person/:id/documents/:doc_id

Update an existing onboarding document for a legal person.

Request​

Path Parameters

    id stringrequired

    Onboarding ID.

    doc_id stringrequired

    Legal person onboarding document ID to be updated.

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

    file binaryrequired

    Allowed file formats: application/pdf, image/jpeg, image/jpg, image/png.

Responses​

The legal person onboarding document updated successfully.

Schema
    id stringrequired

    Legal person onboarding document ID.

    file_id stringrequired

    File ID.

    type stringrequired

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

    Document type.

    created_at date-timerequired

    Document creation date.

    updated_at date-timerequired

    Document update date.

Loading...