Skip to main content

List Onboarding Documents

GET 
/v1/users/onboardings/:id/documents

Get all onboarding documents related to the logged or target user.

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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

The onboarding documents returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Onboarding document files.

  • Array [
    • file_id objectrequired

    Onboarding document file ID.

    file_name objectrequired

    Onboarding document file name.

    created_at objectrequired

    Onboarding document file created at.

  • ]
Loading...