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

    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.

Responses​

The onboarding documents returned successfully.

Schema
  • Array [
    • file_id objectrequired

    Onboarding document file ID.

    file_name objectrequired

    Onboarding document file name.

    created_at objectrequired

    Onboarding document file created at.

  • ]
Loading...