Skip to main content

Upload Merchant Onboarding Document

POST 
/v1/users/merchant-onboarding/:id/documents

Upload required documents for merchant onboarding (max size: 10 MB).

Required documents depend on Dock configuration for each client.

Request​

Path Parameters

    id stringrequired

    Merchant Onboarding ID.

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: [cnpj_card, social_contract, identity_document, address_proof, bank_statement, selfie]

    Document type. Possible values: cnpj_card, social_contract, identity_document, address_proof, bank_statement, selfie.

    document_slug stringrequired

    Document slug identifier for the document type.

    file binaryrequired

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

Responses​

The document uploaded successfully.

Schema
    merchant_onboarding_id stringrequired

    Merchant Onboarding ID.

    merchant_onboarding_status objectrequired

    Merchant Onboarding status.

    document_id stringrequired

    Document ID created by this upload.

    file_id stringrequired

    File ID associated with the uploaded document.

    document_type stringrequired

    Possible values: [cnpj_card, social_contract, identity_document, address_proof, bank_statement, selfie]

    Document type. Possible values: cnpj_card,social_contract,identity_document,address_proof,bank_statement,selfie

    document_created_at date-timerequired

    Document creation date.

    document_updated_at date-timerequired

    Document update date.

Loading...