v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

KYC

Get file upload request details

This GET endpoint is used to get file upload request details.
<br> You must specify both the user_token and the file_upload_token in the URL path to identify which user and file upload request to get details for.
<br> Each file upload request includes the file_upload_token, the types of files accepted (files_types_accepted), the time when the request was created, and whether the request is required to proceed with payouts.
<br> The response also includes any referenced attributes (ref_attributes) that link the file request to specific data, such as bank account details or other identifiers.
<br> The response will be a json object with the details of file upload request, which can then be used to determine what documents need to be uploaded by the user.

get/payout/file_uploads/{user_token}/{file_upload_token}

Response

file_upload_tokenstring required

File upload request token. Need to reference this token when uploading files.

files_types_acceptedstring[] required

Types of files that can be accepted

time_of_requeststring date-time required

Date and time the file upload request was created

is_requiredboolean required

Indication whether this file upload is required in order to initiate payouts

ref_attributesobject required

An object with referenced attributes that this document collection is related to. For example, it may contain the bank account and bank routing numbers for which we require a bank statement.

is_completedboolean required

Indicate whether the file request was completed

time_completedstring date-time

If completed, the date and time when it was completed

is_verifiedboolean required

Indicate wether the file request was verified and is considered completed

notestring

Optional note that will provide additional context about the file upload request

file_upload_linkstring

If the request has not yet been completed, this field contains a URL where the user can upload the required files.

Example response

{
  "file_upload_token": "file_req_f8d2f013-58cd-4ccc-b12d-c373f4d89eab",
  "files_types_accepted": [
    "Bank Deposit"
  ],
  "note": "Enter all pages of the utility bill"
}