Create an account
const url = 'https://api.tovarifinancial.com/accounts';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","accountType":"checking","institution":"example","maskLast4":"example","startingBalanceCents":1,"apy":1,"creditLimitCents":1,"includeInSafeToSpend":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.tovarifinancial.com/accounts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "accountType": "checking", "institution": "example", "maskLast4": "example", "startingBalanceCents": 1, "apy": 1, "creditLimitCents": 1, "includeInSafeToSpend": true }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Optional idempotency key for safe write retries. Every operation that declares this header reads it. Three cases, told apart per operation: (1) where the operation also documents a 409 whose codes include IDEMPOTENCY_CONFLICT, replaying this key with a different payload returns 409 IDEMPOTENCY_CONFLICT and replaying it with the same payload returns the original response; (2) where it documents no 409, a replay is reconciled optimistically against a unique key column and answers the original 200; (3) where it documents a 409 whose codes do NOT include IDEMPOTENCY_CONFLICT, a conflict on this key is impossible — a replay answers a 200, and that 409 is a resource-state conflict described by the operation’s own 409 schema.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Integer minor units (cents). For credit_card and loan this is the AMOUNT OWED: any safe integer is accepted and stored as -|value| (0 stays 0), so a positive owed amount and a stored negative value mean the same debt. For checking, savings and investment it must be >= 0 and is stored as given. On PUT the rule keys on the effective type (the body accountType, else the stored one); a PUT that changes accountType across the asset/liability boundary without this field re-signs the stored value. Responses return the stored signed value.
Integer minor units (cents)
Responses
Section titled “Responses”Created account
object
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
object
Integer minor units (cents)
Integer minor units (cents)
object
The bank’s own instant for plaidLastBalanceCents (Plaid’s last_updated_datetime, else the last live sync-page write). Non-null only when bankBalanceAsOfBasis is provider or sync-page. plaidLastBalanceAt is OUR read time and must never be rendered as a bank as-of.
Where bankBalanceAsOf comes from. cached = nothing dates the figure (a cached read with no provider time): bankBalanceAsOf is null and only bankBalanceCheckedAt travels. Non-null exactly when plaidLastBalanceCents is non-null.
OUR read time for a cached figure (render as “checked”, never “as of”). Non-null only when bankBalanceAsOfBasis is cached.
Plaid’s available balance, signed integer cents. Null for credit_card, loan and investment accounts, when Plaid supplied none, or when plaidLastBalanceCents is null.
Working ledger vs bank figure: matches (equal), pending-activity (cleared equals the bank figure), in-transit (neither — recent bank activity may not have arrived yet). The single render gate for the per-account bank line; non-null only for linked, active, non-investment, reported accounts with a bank figure.
Working ledger balance minus the bank figure. Informational; non-null exactly when bankBalanceComparison is non-null.
object
Why the account can only be closed FOR THIS CALLER, in precedence order admin_only (the caller is not a household admin, KAN-3437) > linked_to_bank > has_cross_account_transfer > scheduled_transfer_target. Null exactly when eligible is true.
Live (not soft-deleted) transactions of the account.
Every bill on the account, active or not. All are deleted with it.
Example
{ "data": { "accountType": "checking", "balanceSource": "ledger", "investmentValue": { "state": "value", "source": "plaid-holdings" }, "taxTreatment": { "bucket": "taxable", "source": "detected", "detectedBucket": "taxable", "confirmationState": "unconfirmed", "promptReason": "ira_traditional_or_roth" }, "bankBalanceStatus": "reported", "bankBalanceAsOfBasis": "provider", "bankBalanceComparison": "matches", "permanentDelete": { "reason": "admin_only" } }}Validation failed — see errorCode / fieldErrors
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Missing, invalid, or expired bearer token
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.
object
Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.
object
Active policy versions the user has not yet accepted.
object
True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.
Example
{ "errorCode": "EMAIL_NOT_VERIFIED"}Conflict. errorCode is IDEMPOTENCY_CONFLICT when an X-Idempotency-Key was replayed with a different request payload; where the operation instead detects a resource-state conflict it carries that endpoint’s own errorCode (a duplicate name, an import that is no longer committable, an account already linked to a bank connection).
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Internal error (no internal detail leaked)
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}