Skip to main content
POST
Suggest a type for 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.

Body

application/json
document_id
string
required

The document id, from list_documents.

Required string length: 1 - 60

Response

Created.

object
enum<string>
required
Available options:
document_type_suggestion
id
string
required
document_id
string
required
status
enum<string>
required

pending while the document is read, ready, or failed (ask again).

Available options:
pending,
ready,
failed
name
string | null
required

A short name for this kind of document. Null until ready.

issuer
string | null
required
description
string | null
required
fields
object[]
required

At most 12 labelled values found on the page.

created_at
string
required

An ISO 8601 time in UTC.