Store an approved assertion for one canonical account term.

Store an approved assertion for one canonical account term.

post/v1/account-terms/assertion

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/account-terms/assertion
  • 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.

fieldstring required

The canonical account-term field, such as apr.purchase, minimum_payment, promo_expiry_date, or apy.

effective_fromstring date-time

When this approved assertion begins applying.

effective_throughstring date-time

When this approved assertion stops applying.

approval_notestring

What the user actually approved, in their terms.

approval_sourcestring

Where that approval happened, 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 stored assertion and any superseded assertion id.

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.