Skip to main content

Update Onboarding Document File by ID

PUT 
/v1/users/onboardings/:id/documents/:doc_id

Update an onboarding document file by providing its ID. If you haven't uploaded a file yet, use the appropriate endpoint to do so.

Request​

Path Parameters

    doc_id stringrequired

    onboarding document file ID to be updated.

    id stringrequired

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

    Possible values: [rg, cnh]

    Document type specified for document_front and document_back. Required when send this files. Possible values: rg,cnh.

    type string

    Possible values: [selfie, document_front, document_back, address_proof]

    Document type related to previous uploaded document. Possible values: selfie,document_front,document_back,address_proof.

    document binary

Responses​

The onboarding document file updated successfully.

Loading...