Skip to main content
GET
Retrieve a file

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

fileId
string<uuid>
required

The file id from Upload a file.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

id
string<uuid>
required

The file ID. Use it to retrieve the file and to attach it as a receipt.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
purpose
enum<string>
required

What the file is for. card_receipt is a receipt you attach to a card transaction.

Available options:
card_receipt
filename
string | null
required

The file name we stored. It is null until the file is ready, and the extension matches the real file type.

size
integer
required

The file size in bytes.

Required range: 0 <= x <= 9007199254740991
contentType
string
required

The file type we detected from its content, for example application/pdf.

status
enum<string>
required

The malware scan result: checking (still scanning), ready (safe to attach), blocked (a threat was found) or failed (the scan could not finish).

Available options:
checking,
ready,
blocked,
failed
createdAt
string<date-time>
required

When the file was uploaded, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
reason
enum<string>

Why the file is blocked or failed: threat or unscannable.

Available options:
threat,
unscannable