MAmasspay
KYC

Get file upload requests by user token

Changed on

This GET endpoint retrieves the list of file upload requests associated with a specific user.
<br> You must provide the user_token in the URL path to identify the user.
<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> You can use the optional query parameter only_required to filter results and return only those file upload requests that are mandatory.
<br> The response will be an array of file upload requests, which can then be used to determine what documents need to be uploaded by the user.
<br> Rejected requests are returned with status rejected, time_rejected, rejection_reason (when given) and replacement_file_upload_token; they no longer count toward any requirement.

get/payout/file_uploads/{user_token}

Request

Query parameters

only_requiredboolean

When set to true, will only return required file upload requests. Otherwise, return also optional

only_incompleteboolean

When set to true, will only return incomplete file upload requests, otherwise return all

Response

OK

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

is_rejectedboolean required

Indicate whether the uploaded files were rejected (time_rejected is set); a rejected request no longer counts toward any requirement

status'pending' | 'uploaded' | 'verified' | 'rejected' required

Status of the file upload request: rejected when the uploaded files were rejected (time_rejected is set); otherwise verified when is_verified is true; otherwise uploaded when files were received (time_completed is set); otherwise pending

time_rejectedstring date-time

Set when the uploaded files were rejected

rejection_reasonstring

Reason given when the files were rejected, when one was provided

replacement_file_upload_tokenstring

When rejected, the token of the replacement request opened for the same requirement

replacement_file_upload_linkstring uri

Only on the single-request endpoint: upload link for the replacement request

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"
  }
]

Changes

  • f9fa41b7c45cRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status