Skip to main content

Upload Onboarding Document File by ID

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

Upload onboarding documents (up to 25 MiB per file). Provide one of the following document combinations:

<ul>
  <li>Provide selfie, document_front, document_back and document_file_type.</li>
  <li>Provide selfie and document_id.</li>
</ul>
Submitting all required documents starts onboarding processing; the final result is asynchronous.
If you have submitted a liveness video for this onboarding, also provide document_front as a JPEG or PNG image up to 5 MiB, including when using document_id. This image is required to compare the person in the video with the identity document. A missing or incompatible image prevents processing from starting; correct it while the onboarding is pending.

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

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

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. Requires selfie. If a liveness video has been submitted, document_front is also required for face comparison.

    document_front binary

    Front side of the document. Required when document_id is not provided or a liveness video has been submitted. For comparison with a submitted video, provide JPEG or PNG up to 5 MiB.

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