Skip to main content

Get All Client Documents

GET 
/v1/crossborder/clients/:id/documents

Retrieve a list of all documents associated with a specific crossborder client. Optional filter parameters can be used to refine your search.

Request​

Path Parameters

    id stringrequired

    Client ID.

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort object

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    document_type string

    Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]

    Filter by document type.

    status string

    Possible values: [PENDING, APPROVED, REJECTED, EXPIRED]

    Filter by document status.

    file_state string

    Possible values: [PENDING, WAITING_UPLOAD, READY, ERROR, ABORTED]

    Filter by file state.

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​

Client 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

    Client documents data.

  • Array [
    • id stringrequired

    Client document ID.

    client_id stringrequired

    Client ID.

    user_id stringrequired

    User ID.

    file_id stringrequired

    File ID.

    file_state stringrequired

    Possible values: [PENDING, WAITING_UPLOAD, READY, ERROR, ABORTED]

    File state.

    name stringrequired

    Document name.

    description string

    Document description.

    expiration_date string

    Document expiration date.

    type stringrequired

    Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]

    Document type.

    status stringrequired

    Possible values: [PENDING, APPROVED, REJECTED, EXPIRED]

    Document status.

    created_at date-timerequired

    Document created date.

    updated_at date-timerequired

    Document updated date.

  • ]
Loading...