Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.finpace.tech/llms.txt

Use this file to discover all available pages before exploring further.

​
API conventions

​
Authentication and authorization

All external API calls are expected to use:
  • OAuth 2.0 or OIDC for delegated access
  • mTLS for high-trust server integrations
  • scoped bearer tokens for application access
  • explicit service principals for machine-to-machine integrations

​
Idempotency

The following operations must require an Idempotency-Key header:
  • payment initiation
  • account opening
  • posting instruction submission
  • credit application submission
  • drawdown booking
  • document upload registration
  • AI governed tool execution for state-changing commands
A repeated request with the same semantic payload and key returns the original accepted result.

​
Maker-checker and approval pattern

For protected actions, Finpace uses a staged command model.
  1. Client submits a command
  2. Platform validates syntax and entitlement
  3. Command enters pending_approval if approval is required
  4. Approval actors can approve, reject, or return for amendment
  5. The command is executed only after the control profile is satisfied
  6. Execution evidence is attached to the originating command record

​
Eventing

Events are emitted for:
  • arrangement state changes
  • posted transactions
  • payment status changes
  • document lifecycle actions
  • task status changes
  • credit decision events
  • covenant breach detection
  • AI tool evaluation and execution outcomes

​
Event design rules

  • immutable payload
  • event id
  • causation id
  • correlation id
  • occurred timestamp
  • tenant id
  • actor context
  • business object reference

​
Error model

The API error model uses a machine-readable structure: 
{
  "errorCode": "LIMIT_BREACH",
  "message": "Payment exceeds available arrangement limit.",
  "category": "business_rule",
  "correlationId": "01J123ABCXYZ",
  "details": [
    {
      "field": "amount",
      "issue": "exceeds_limit"
    }
  ]
}

​
Versioning

This package uses path-stable resources and additive evolution principles:
  • avoid breaking field renames
  • add optional fields first
  • deprecate with notice
  • isolate behavioral changes behind policy or capability flags where possible