Skip to main content
POST
Approve a document value

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_value
string
required

The value id, from list_document_values.

Required string length: 1 - 60

Body

application/json
value
string | null
Maximum string length: 500

Response

Success.

object
enum<string>
required
Available options:
document_value
id
string
required
document_id
string
required
key
string
required

The field, such as closing_balance.

value
string | null
required

What is kept. Dates are YYYY-MM-DD and amounts dollars with two decimals. Null when the document did not have it.

read_value
string | null
required

As read. Null when not found; an empty string when found and blank.

status
enum<string>
required

to_review, approved, or missing (not in this document).

Available options:
to_review,
approved,
missing
flagged
boolean
required

Read with low confidence: approve or change these before the rest.

confidence
number | null
required
page
number | null
required
changed_by_member_id
string | null
required
decided_at
string | null
required

An ISO 8601 time in UTC.