v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

File Service

Get File Download Links

Get file download links. Populate the download request with a list of file IDs and the API responds with associated download links. Files do not exceed 20MB.

post/v1/files/download_links

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Request body

file_idsstring[] required

List of file IDs to retrieve download links for.

Example request

{
  "file_ids": [
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b1",
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b2"
  ]
}

Response

OK - Successfully get file download links.

absent_filesstring[]

List of file IDs that were requested but could not be found.

Example response

{
  "files": [
    {
      "file_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
      "file_type": "png",
      "file_name": "example.png",
      "size": 123456,
      "url": "https://files.uqpaytech.com/api/v1/files/b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
    }
  ],
  "absent_files": [
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b1",
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b2"
  ]
}