Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Files

Retrieve a file

Retrieve a file by its unique ID

get/files/{fileId}

Path parameters

fileIdstring required
Example:fl_01FCTS1XMKH9FF43CAFA4CXT3P

File to retrieve

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this if you need to fetch a particular file for a sub account)

Response

Successfully retrieved the given File

idstring

The ID of the file

namestring

Name of the file

type'Csv' | 'Jpg' | 'Png' | 'Pdf'

The type of the file

category'Report' | 'Evidence' | 'VerificationDocument'

The category of the file

metadataobject nullable

Any additional key-value data you have attached to the file. These will be sent with any associated file events on your webhooks. You can have a maximum of 5 pieces of metadata.

createdTimestampinteger

The epoch timestamp (seconds) when the file was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the file was last updated

sizeInBytesinteger nullable

The size in bytes of the associated file

Example response

{
  "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "name": "receipt_2024.png",
  "type": "Pdf",
  "category": "Evidence",
  "metadata": {
    "customerId": "1",
    "registered": "123"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538,
  "sizeInBytes": 2048
}