Files

Overview

The files API endpoint in Tap is used to upload files to the Tap server. This is typically used in the onboarding process for merchants, where the file IDs are required for creating a business account, uploading required documents such as ID, commercial registration license, and logo, and for other API requests.

File Request Example

To upload a file, a request of type multipart/form-data is required. The request must include the file to be uploaded, as well as the parameters for creating a file. These parameters are listed in the File Body Request Table.

After the file is uploaded, the response will include a file ID that can be used to reference the file in other API requests. It is important to note that there are limits to the file size and type that can be uploaded, and files that exceed these limits will not be accepted by the Tap server.

File Body Request Table (multipart/form-data)

File Purpose Table

File Format Table (Possible values)

File Response Example

After uploading a file, the JSON response will be returned with the file id that is required in some APIs. In the following table, you will find the response details.

{
  "id": "file_641212279714869248",
  "object": "file",
  "live_mode": false,
  "api_version": "1.0",
  "feature_version": "1.0",
  "created": 1572947320,
  "filename": "8801760e0a28ae2105e4ada503e30b8c.jpg",
  "purpose": "identity_document",
  "size": 346827,
  "title": "test",
  "type": "jpg",
  "url": "/files/file_641212279714869248",
  "links": [
    {
      "id": "link_641212281036075008",
      "object": "file_link",
      "live_mode": true,
      "api_version": "1.0",
      "feature_version": "1.0",
      "created": 1572947320,
      "expired": false,
      "expires_at": 1234567,
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "url": "/links/fl_test_641212281036075009"
    }
  ]
}