Skip to main content
POST
/
v1
/
files
/
download_links
Get File Download Links
curl --request POST \
  --url https://files.uqpaytech.com/api/v1/files/download_links \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "file_ids": [
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b1",
    "b3d9d2d5-4c12-4946-a09d-953e82sed2b2"
  ]
}
'
{
  "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"
  ]
}

Authorizations

​
x-auth-token
string
header
required

Token used to request APIs

Headers

​
x-on-behalf-of
string

The value set to the connected account's ID. More information at List Connected Accounts

Body

application/json
​
file_ids
string<uuid>[]
required

List of file IDs to retrieve download links for.

Example:
[
  "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
  "b3d9d2d5-4c12-4946-a09d-953e82sed2b1",
  "b3d9d2d5-4c12-4946-a09d-953e82sed2b2"
]

Response

OK - Successfully get file download links.

​
files
object[]

List of files with their download links.

​
absent_files
string<uuid>[]

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

Example:
[
  "b3d9d2d5-4c12-4946-a09d-953e82sed2b1",
  "b3d9d2d5-4c12-4946-a09d-953e82sed2b2"
]