Skip to main content
POST
Read a document as a type

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

Body

application/json
doc_type
string
required

The type to read it as, such as tax_return or super_statement: a key from list_document_types.

Required string length: 1 - 64

Response

Success.

object
enum<string>
required
Available options:
document
id
string
required
ok
enum<boolean>
required
Available options:
true