Improved

October 25th 2025

Improved

List file upload requests

The GET endpoint /payout/file_uploads/{user_token} was enhanced to make it easier to track document collection status and filter pending requests.

  • New query parameter

    • only_incomplete (boolean, optional) — When true, returns only file upload requests that are not yet completed; otherwise returns all requests.
  • Response schema extended (per item)

    • is_completed (boolean) — Indicates whether the file request has been completed.
    • time_completed (string, date-time) — Timestamp of completion when available.
    • is_verified (boolean) — Indicates whether the completed upload was reviewed and verified.

200 Response (example)

[
  {
    "file_upload_token": "file_req_06944559-812c-4c41-a344-767591c57c5d",
    "files_types_accepted": ["Bank Statement", "Paper Check"],
    "time_of_request": "2025-05-26 07:22:56",
    "is_required": true,
    "ref_attributes": { "Account Number": "************4242" },
    "is_completed": true,
    "time_completed": "2025-08-24T14:15:22Z",
    "is_verified": true
  }
]

Added

Get file upload request details

Introduced a new GET endpoint at /payout/file_uploads/{user_token}/{file_upload_token} to retrieve detailed information about a specific file upload request.

  • Returns a FileUploadResp object containing:
    • file_upload_token – Identifier of the file upload request.
    • files_types_accepted – List of accepted document types (e.g., Bank Statement, Paper Check).
    • time_of_request – Timestamp of when the request was created.
    • is_required – Indicates whether this file upload is required to proceed with payouts.
    • ref_attributes – Metadata linking the request to specific attributes (e.g., masked bank account information).
    • is_completed – Whether the file request has been completed.
    • time_completed – Completion timestamp, when applicable.
    • is_verified – Whether the uploaded files were reviewed and verified.

200 Response (example)

{
  "file_upload_token": "file_req_06944559-812c-4c41-a344-767591c57c5d",
  "files_types_accepted": ["Bank Statement", "Paper Check"],
  "time_of_request": "2025-05-26 07:22:56",
  "is_required": true,
  "ref_attributes": { "Account Number": "************4242" },
  "is_completed": true,
  "time_completed": "2025-08-24T14:15:22Z",
  "is_verified": true
}