Store an approved account inclusion and role policy.

Store an approved account inclusion and role policy.

post/v1/accounts/policy

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/accounts/policy
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

account_identity_idstring required

The durable account identity this concerns, which survives a reconnected source connection.

include_in_workspaceboolean required

Excluding an account removes it from balances, net position, and cashflow everywhere, not just from one view.

role'operating_cash' | 'cash_reserve' | 'health_savings' | 'retirement' | 'investment' | 'credit_card' | 'debt' | 'unknown'

Overrides the role derived from account type. Set it only when the user tells you the derived role is wrong, since roles drive runway and reserve math.

approval_notestring

What the user said about this, in their words, recorded so a later run can tell their decision from your inference. Optional; without it the action's reason is kept. Not a restatement of the change itself.

approval_sourcestring

Where the user said it, such as the conversation or message it came from.

set_bystring

Who made the change, when it was not you acting alone.

Response

Envelope with the active approved account policy.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.