---
title: "Upload Documents to Payout"
source_url: https://docs.rapyd.net/en/upload-documents-to-payout.html
lang: en
---

# Upload Documents to Payout

Upload one supporting document file or multiple document files to a specific payout. These documents include ID scans, company registrations, and all other documents that support the validity of the payout. A file can be uploaded only when the payout is in a **Created**, **Hold**, or **Pending** status.

> **Note:**
>
> - The code samples include successful requests (200) and bad requests (400).
>
>   - For error messages that appear due to bad requests (400), see:
>
>     - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors")
>     - [Document Errors](https://docs.rapyd.net/en/document-errors.md "Document Errors")
>     - [Payout Errors](https://docs.rapyd.net/en/payout-errors.md "Payout Errors")
>   - For information about unauthorized request (401) and other authentication errors, see [Troubleshooting Authentication and Authorization Errors](https://docs.rapyd.net/en/troubleshooting-authentication-and-authorization-errors.md "Troubleshooting Authentication and Authorization Errors").

### Parameters

### Request Path Parameters

- - payout
  - ID of the payout. String starting with **payout_**.

### Request Header Parameters

- - access_key
  - Unique access key provided by Rapyd for each authorized user.

    See [Developers](https://docs.rapyd.net/en/developers.md "Developers").
- - Content-Type
  - Indicates that the data appears as a file. Set to **multipart/form-data**.
- - idempotency
  - A unique key that prevents the platform from creating the same object twice.

    See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency").
- - salt
  - Random string. Recommended length: 8-16 characters.
- - signature
  - Signature calculated for each request individually.

    See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures").
- - timestamp
  - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Request Input File

- - file
  - Use the `-F` or `--form` parameter to define the path to the document file on your local machine. Supported file types include '*.pdf', '*.doc', '*.docx', '.*csv', '*.jpeg', '*.jpg', '*.gif', '*.png'. Format of input must follow the `multipart/form-data` protocol. Use the `files` parameter to upload multiple files.

    > **Note:**
    >
    > - * Maximum number of files that can be uploaded in one request is 10.
    >
    > - * Maximum size of files that can be uploaded in one request is 20 MB.
    >
    > - * Document file name should be up to 200 characters long.

### Request Body Parameters

None.

### Response Parameters

The following parameters are returned for each file that was uploaded.

- - payout_token
  - ID of the payout. String starting with **payout_**.
- - file_id
  - ID of the uploaded file. UUID.
- - file_name
  - The name of the document file.
- - file_extension
  - The uploaded file's extension.
- - created_at
  - The date and time when the file was successfully uploaded. Format is **YYYY-MM-DD HH:MM:SS**.

- /v1/files/documents/payout/:payout

- Upload File to Payout
- ```bash
  curl -X post
  'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_548969fc5a0bf89da3cec70a1529338d' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: multipart/form-data' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  -F 'file=@"/your-file-location/file.jpg"'
  ```
- ```json
  {
      "status": {
          "error_code": "",
          "status": "SUCCESS",
          "message": "",
          "response_code": "",
          "operation_id": "411b1685-fec6-42cb-8cde-02eca47f5c4d"
      },
      "data": [
          {
              "payout_token": "payout_548969fc5a0bf89da3cec70a1529338d",
              "file_id": "e0b0ef98-2fac-4dcd-86c7-e1062bfd1c55",
              "file_name": "file.jpg",
              "file_extension": "jpg",
              "created_at": "2024-10-30 07:55:36"
          }
      ]
  }
  ```

- Upload Multiple Files to Payout
- ```bash
  curl -X post
  'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_548969fc5a0bf89da3cec70a1529338d' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: multipart/form-data' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  -F 'file=@"/your-file-location/License.jpg"' \
  -F 'file=@"/your-file-location/Company_registration.jpg"'
  ```
- ```json
  {
  	"status": {
  		"error_code": "",
  		"status": "SUCCESS",
  		"message": "",
  		"response_code": "",
  		"operation_id": "fab397ad-93c3-4b8b-a2f0-dbfb23447524"
  	},
  	"data": [{
  		"payout_token": "payout_548969fc5a0bf89da3cec70a1529338d",
  		"file_id": "4260335d-1081-4c2f-b523-397aa30e50ff",
  		"file_name": "License.jpg",
  		"file_extension": "jpg",
  		"created_at": "2024-11-12 09:52:33"
  	}, {
  		"payout_token": "payout_548969fc5a0bf89da3cec70a1529338d",
  		"file_id": "4fbb1942-dbbb-436a-8ed3-76524bc4b4b1",
  		"file_name": "Company_registration.jpg",
  		"file_extension": "jpg",
  		"created_at": "2024-11-12 09:52:33"
  	}]
  }
  ```

- Bad Request - Upload Document Not Provided
- ```bash
  curl -X post
  'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_a7885752f09567e0f7e508bae27ab29b' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: multipart/form-data' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  -F 'file=@""'
  ```
- ```json
  {
      "status": {
          "error_code": "ERROR_UPLOAD_DOCUMENT_NOT_PROVIDED",
          "status": "ERROR",
          "message": "The request attempted to upload a document, but no document file was provided.  The request was rejected. Corrective action: Rerun the request with a valid document file.",
          "response_code": "ERROR_UPLOAD_DOCUMENT_NOT_PROVIDED",
          "operation_id": "0c8cf66f-6810-4dfa-bc96-cc20044766e5"
      }
  }
  ```

- Bad Request - Unsupported File Type
- ```bash
  curl -X post
  'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_a7885752f09567e0f7e508bae27ab29b' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: multipart/form-data' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  -F 'file=@"/your-file-location/file.xml"'
  ```
- ```json
  {
      "status": {
          "error_code": "ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE",
          "status": "ERROR",
          "message": "The request tried to upload a file, but the file type was not supported. The request was rejected. Corrective action: Upload a file that is of a supported file type.",
          "response_code": "ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE",
          "operation_id": "0c8cf66f-6810-4dfa-bc96-cc20044766e5"
      }
  }
  ```