Retrieve a file
curl --request GET \
--url https://api.global.direct.reap.global/2026-11-05/files/{fileId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.global.direct.reap.global/2026-11-05/files/{fileId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.global.direct.reap.global/2026-11-05/files/{fileId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "8f14e45f-ceea-4e67-a1b2-0f3c9d7a1b11",
"purpose": "card_receipt",
"filename": "invoice-INV-20431.pdf",
"size": 48213,
"contentType": "application/pdf",
"status": "ready",
"createdAt": "2026-10-29T01:00:00.000Z"
}Files
Retrieve a file
Required API-key scope: the scope for the file’s purpose. For card_receipt, that’s card_activities:write.
Returns an uploaded file and its malware scan status. Call it every 2 to 5 seconds after Upload a file until status is ready.
status | Meaning | What to do |
|---|---|---|
checking | We’re still scanning the file. | Call again in 2 to 5 seconds. |
ready | The file is safe to use. | Attach it within 24 hours. |
blocked | The scan found a threat. | Upload a different file. |
failed | The scan couldn’t finish. | Upload a different file. |
- Files are deleted 1 to 2 days after upload.
- An unknown or expired file, or one from another business, returns
FILE_NOT_FOUND.
GET
/
2026-11-05
/
files
/
{fileId}
Retrieve a file
curl --request GET \
--url https://api.global.direct.reap.global/2026-11-05/files/{fileId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.global.direct.reap.global/2026-11-05/files/{fileId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.global.direct.reap.global/2026-11-05/files/{fileId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "8f14e45f-ceea-4e67-a1b2-0f3c9d7a1b11",
"purpose": "card_receipt",
"filename": "invoice-INV-20431.pdf",
"size": 48213,
"contentType": "application/pdf",
"status": "ready",
"createdAt": "2026-10-29T01:00:00.000Z"
}Path Parameters
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
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))$