The File object

The File object contains information about a file.

Attributes

Description

id string

Unique identifier of the file.

createdTime datetime

The time when the file was created.

fileName string

A filename for the file, suitable for saving to a filesystem.

links [Object]

Contains links information.

links[].id string

Unique identifier for the file link.

links[].createdTime datetime

The time when the file link was created.

links[].expired boolean

Whether this link has already expired.

links[].expiresTime boolean

Time at which the link expires.

links[].fileId string

The unique identifier of the file link.

links[].liveMode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

links[].url string

The publicly accessible URL to download the file.

purpose string

The purpose of the uploaded file.

title string

A user-friendly title for the document.

size number

The size in bytes of the file object.

type string

The type of the file returned (for example, pdf, jpg, or png).

url string

The URL from which the file can be downloaded using your live secret API key.

liveMode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

The File object
The File object
{
"id": "file_09e2464f-9b4f-482b-ae89-732183c705be",
"createdTime": "2018-04-25T20:36:00Z",
"fileName": "file.png",
"links": [
{
"id": "link_d992b05c-31d3-485e-b1f7-7b95f06cbfe8",
"createdTime": "2018-04-25T20:36:00Z",
"expired": false,
"expiresTime": "2020-04-25T20:36:00Z",
"fileId": "file_09e2464f-9b4f-482b-ae89-732183c705be",
"liveMode": false,
"url": "https://files.digitalriver.com/links/fl_29a093a2-8989-4def-a50c-d8950d1436d4"
}
],
"purpose": "tax_document_customer_upload",
"title": "My 2019 Tax Certificate.",
"size": 72334,
"type": "png",
"url": "https://files.digitalriver.com/files/file_17a0cab7-1ff7-478e-99f9-d4e753dec24d/contents",
"liveMode": false
}