Skip to main content
GET
/
v1
/
files
/
{file_id}
Get File
curl --request GET \
  --url https://api.example.com/v1/files/{file_id}
{
  "id": "<string>",
  "status": "pending_upload",
  "fileName": "<string>",
  "contentType": "application/pdf",
  "purpose": "authorization_attachment",
  "createdAt": "2023-11-07T05:31:56Z",
  "sizeBytes": 123,
  "completedAt": "2023-11-07T05:31:56Z",
  "uploadUrl": "<string>",
  "downloadUrl": "<string>"
}

Path Parameters

​
file_id
string
required

Response

Successful Response

​
id
string
required
​
status
enum<string>
required
Available options:
pending_upload,
uploaded,
ready,
failed
​
fileName
string
required
​
contentType
enum<string>
required
Available options:
application/pdf,
image/jpeg,
image/png
​
purpose
enum<string>
required
Available options:
authorization_attachment,
test_ingress_payer_document,
generated_artifact,
preview_document,
inbound_document
​
createdAt
string<date-time>
required
​
sizeBytes
integer | null
​
completedAt
string<date-time> | null
​
uploadUrl
string | null
​
downloadUrl
string | null