Skip to main content
GET
Get Document Endpoint

Authorizations

Authorization
string
header
required

Your Folio API key, sent as Authorization: Bearer <api_key>.

Headers

authorization
string | null

Path Parameters

document_id
string
required

Query Parameters

wait
integer
default:0
Required range: x >= 0

Response

Successful Response

completed_at
string<date-time> | null
required
content_type
string | null
required
created_at
string<date-time>
required
document_type
string | null
required
expires_at
string<date-time> | null
required
filename
string | null
required
id
string
required
language
enum<string>
required
Available options:
fr,
en,
auto
metadata
Metadata · object | null
required
result_url
string
required
size_bytes
integer | null
required
status
enum<string>
required
Available options:
received,
queued,
processing,
completed,
partially_completed,
failed,
deleted
updated_at
string<date-time>
required
object
string
default:document