Skip to main content
GET
Get a document

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
document
string
required

The document id, from list_documents.

Required string length: 1 - 60

Response

Success.

object
enum<string>
required
Available options:
document
id
string
required
file_name
string
required
mime_type
string
required
size_bytes
number
required
status
enum<string>
required

uploaded (waiting to be read), reading, read, unreadable, or replaced by a newer upload.

Available options:
uploaded,
reading,
read,
unreadable,
replaced
doc_type
string | null
required

The kind of document, such as super_statement or payslip. Null until read.

doc_type_label
string | null
required
statement_date
string | null
required

The date the document carries, YYYY-MM-DD.

page_count
number | null
required
failure
string | null
required

Why it could not be read, in words for the client.

uploaded_by
object | null
required
checklist_item_id
string | null
required
replaced_by_id
string | null
required
facts_proposed
number
required
facts_accepted
number
required
review_status
enum<string>
required

Where the firm’s review stands: reading, to_review (values wait for approval), choose_type (we could not tell what it is), couldnt_read, approved, filed (kept as a file only) or sent_back.

Available options:
reading,
to_review,
choose_type,
couldnt_read,
approved,
filed,
sent_back
values_read
number
required

How many values were read from it.

values_to_review
number
required

Values waiting for approval.

values_to_check
number
required

Values waiting that were read with low confidence and are checked first.

created_at
string
required

An ISO 8601 time in UTC.

read_at
string | null
required

An ISO 8601 time in UTC.

reviewed_at
string | null
required

An ISO 8601 time in UTC.

facts
object[]
required
balances
object[]
required
account_ids
string[]
required

The accounts this document made or fed, for get_account.