Skip to main content

Upload Onboarding Document File by ID

POST 
/v1/users/onboardings/:id/documents

Upload the onboarding document file (max size: 20 MB). There are two ways to complete onboarding: 1) Provide selfie, document_front, document_back and document_file_type, or 2) Provide only selfie and document_id. The process is finished once all required documents are submitted based on the chosen method.

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

    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
    document_file_type string

    Possible values: [rg, cnh]

    Document type specified for document_front and document_back. Required when not using document_id. Possible values: rg,cnh.

    document_id string

    Document ID for digital identity validation. When provided, only selfie is required and document_front/document_back are not needed.

    document_front binary

    Front side of the document. Required when document_id is not provided.

    document_back binary

    Back side of the document. Required when document_id is not provided.

    selfie binary

    User selfie. Always required.

    address_proof binary

    Proof of address document. Optional.

Responses​

The file upload returned successfully.

Loading...