Skip to main content
PATCH
Change a document account

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

The account id, from list_accounts.

Required string length: 1 - 60

Body

application/json
institution
string | null
name
string | null
kind
enum<string> | null
Available options:
transaction,
savings,
credit_card,
loan,
mortgage,
super,
shares,
investment,
other
last_four
string · null · null

Response

Success.

object
enum<string>
required
Available options:
account
id
string
required
source
enum<string>
required

From a connected bank, or built from a document such as a super statement.

Available options:
connection,
document
institution
string
required
name
string
required
kind
enum<string>
required
Available options:
transaction,
savings,
credit_card,
loan,
mortgage,
super,
shares,
investment,
other
masked_number
string | null
required
currency
string
required
connection_id
string | null
required
balance
object | null
required

The newest accepted balance.

proposed_balance
object | null
required

A balance a document proposed that waits for accept_balance or reject_balance.

created_at
string
required

An ISO 8601 time in UTC.

history
object[]
required
documents
object[]
required