Skip to main content

Update Legal person onboarding document.

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

Update an existing legal person document for a legal person onboarding.

Request​

Path Parameters

    id stringrequired

    Legal person onboarding ID.

    doc_id stringrequired

    Legal person onboarding document ID to be updated.

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    type stringrequired

    Possible values: [social_contract, balance_sheet, revenue_statement, kyc_aml_policy]

    Document type (API values).

    file binaryrequired

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

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: [social_contract, balance_sheet, revenue_statement, kyc_aml_policy]

    Document type.

    created_at date-timerequired

    Document creation date.

    updated_at date-timerequired

    Document update date.

Loading...