FinanceGPT Developer Platform
API Reference
Find the endpoint you need, inspect its contract, then test it in the sandbox Explorer or copy it into your application.
Start with an outcome
Jump into the contract by intent instead of scanning hundreds of operations.
Find an endpoint
133 matching operations · 388 published total
Operations
Open a contract for parameters and responses, or move directly into the authenticated sandbox Explorer.
| Endpoint | What it does | Scope | Group | |
|---|---|---|---|---|
POST/agent-execution/a2a |
Invoke the signed FinanceGPT agent-to-agent execution gateway | agent:execution:invoke |
Agents & MCP | Contract Try |
GET/agent-execution/actions/{uid} |
Read governed Financial Action status | agent:execution:read |
Agents & MCP | Contract Try |
GET/agent-execution/actions/{uid}/assurance |
Read Financial Actions assurance evidence | agent:execution:read |
Agents & MCP | Contract Try |
POST/agent-execution/actions/{uid}/execute |
Request execution of an already-authorized Financial Action | agent:execution:execute |
Agents & MCP | Contract Try |
GET/agent-execution/actions/{uid}/reconciliation |
Read Financial Action reconciliation evidence | agent:execution:read |
Agents & MCP | Contract Try |
POST/agent-execution/actions/{uid}/submit |
Submit an external-agent Financial Action for approval | agent:execution:submit |
Agents & MCP | Contract Try |
GET/agent-execution/capabilities |
Read signed external-agent execution capabilities | agent:execution:read |
Agents & MCP | Contract Try |
POST/agent-execution/mcp |
Invoke the signed FinanceGPT Financial Actions MCP execution gateway | agent:execution:invoke |
Agents & MCP | Contract Try |
POST/agent-execution/proposals |
Propose a governed Financial Action from an external agent | agent:execution:propose |
Agents & MCP | Contract Try |
GET/agent-execution/webhooks |
List signed Financial Action and workflow lifecycle webhooks | agent:execution:webhooks |
Agents & MCP | Contract Try |
POST/agent-execution/webhooks |
Register a signed HTTPS Financial Action or workflow lifecycle webhook | agent:execution:webhooks |
Agents & MCP | Contract Try |
GET/ai-credits/transactions |
Read the active workspace immutable FinanceGPT AI Credit ledger | ai:credits:read |
AI Runtime & Governance | Contract Try |
GET/ai/model-selections |
Read Universal Model Switching choices for the active workspace | ai:models:read |
AI Runtime & Governance | Contract Try |
GET/finance-core/accounts |
Read ledger accounts | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/accruals |
Read accrual schedules | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/bank-accounts |
Read bank accounts | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/bank-statements |
Read bank statement batches | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/close/cycles |
Read continuous-close cycles | finance-core:close:read |
Core Platform | Contract Try |
GET/finance-core/consolidation-groups |
Read consolidation groups | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/control-policies |
Read accounting control policies | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/entities |
Read accounting entities | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/fixed-assets |
Read fixed assets | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/fx-rate-sets |
Read FX rate sets | finance-core:read |
Core Platform | Contract Try |
POST/finance-core/intake/submissions |
Submit structured accounting intake to the governed staging layer | finance-core:intake:write |
Core Platform | Contract Try |
POST/finance-core/intake/submissions/{submissionUid}/evidence |
Attach immutable provenance evidence to a Finance Core intake submission | finance-core:evidence:write |
Core Platform | Contract Try |
GET/finance-core/journals |
Read journal entries | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/ledgers |
Read general ledgers | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/payables |
Read payable documents | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/periods |
Read accounting periods | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/prepaids |
Read prepaid expense schedules | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/receivables |
Read receivable documents | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/recommendations |
Read accounting-agent recommendations | finance-core:recommendations:read |
Core Platform | Contract Try |
GET/finance-core/reconciliations |
Read cash reconciliations | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/reports/snapshots |
Read financial-statement snapshots | finance-core:reports:read |
Core Platform | Contract Try |
GET/finance-core/revenue-contracts |
Read accounting revenue contracts | finance-core:read |
Core Platform | Contract Try |
GET/finance-core/settlements |
Read subledger settlements | finance-core:read |
Core Platform | Contract Try |
GET/investment/book |
Read the workspace investment book control surface | investment:read |
Core Platform | Contract Try |
GET/investment/governed-ai-operations |
List governed AI investment operations | investment:read |
Core Platform | Contract Try |
POST/investment/governed-ai-operations |
Create a shadow or governed-review investment operation | investment:run |
Core Platform | Contract Try |
POST/investment/governed-ai-operations/{uid}/rebalance |
Create a governed rebalance proposal from sealed evidence | investment:run |
Core Platform | Contract Try |
POST/investment/governed-ai-operations/{uid}/refresh |
Synchronize governed investment evidence and downstream state | investment:run |
Core Platform | Contract Try |
POST/investment/governed-ai-operations/{uid}/seal |
Seal the governed upstream investment evidence packet | investment:run |
Core Platform | Contract Try |
POST/investment/governed-ai-operations/{uid}/submit |
Request human approval for the governed rebalance proposal | investment:run |
Core Platform | Contract Try |
POST/investment/ontology/companies/{symbol}/refresh |
Extract and classify company activity against the published ontology | investment:run |
Core Platform | Contract Try |
GET/investment/portfolios/{portfolio}/book/operations |
Read portfolio front-to-back operating state | investment:read |
Core Platform | Contract Try |
POST/investment/portfolios/{portfolio}/book/seed |
Seed an empty portfolio book from opening evidence | investment:run |
Core Platform | Contract Try |
POST/investment/portfolios/{portfolio}/book/synchronize |
Synchronize governed trade and settlement evidence into the investment book | investment:run |
Core Platform | Contract Try |
POST/investment/portfolios/{portfolio}/construct |
Run governed Portfolio Construction 2.0 | investment:run |
Core Platform | Contract Try |
POST/investment/portfolios/{portfolio}/risk-compliance |
Generate Institutional Risk & Compliance 2.0 evidence | investment:run |
Core Platform | Contract Try |
POST/investment/portfolios/{portfolio}/theme-watch |
Seal a portfolio thematic attribution and drift snapshot | investment:run |
Core Platform | Contract Try |
POST/investment/theme-watch/factors |
Estimate point-in-time thematic factor returns | investment:run |
Core Platform | Contract Try |
POST/investment/themes/discover |
Discover and save an evidence-backed thematic universe from free text | investment:run |
Core Platform | Contract Try |
POST/investment/themes/universes/{universe}/model-portfolio |
Hand a saved thematic universe to a draft model portfolio | investment:run |
Core Platform | Contract Try |
POST/investment/themes/universes/{universe}/watchlist |
Hand a saved thematic universe to an investment watchlist | investment:run |
Core Platform | Contract Try |
GET/trust/evidence |
Read FinanceGPT enterprise trust evidence | trust:read |
Core Platform | Contract Try |
POST/trust/evidence-packs |
Create a sealed workspace enterprise-evidence pack | trust:write |
Core Platform | Contract Try |
GET/commercial/entitlements |
Read the active workspace commercial profile and entitlement matrix | commercial:read |
Developer & Commercial | Contract Try |
GET/commercial/financial-operations |
Read FinanceGPT Financial Operations commercial status | commercial:read |
Developer & Commercial | Contract Try |
POST/commercial/financial-operations/snapshot |
Capture a Financial Operations customer-success snapshot | commercial:write |
Developer & Commercial | Contract Try |
GET/commercial/financial-operations/value |
Read measured Financial Operations customer-success evidence | commercial:read |
Developer & Commercial | Contract Try |
GET/commercial/restricted-autonomy/value |
Read measured Restricted Autonomous Operations outcomes | commercial:read |
Developer & Commercial | Contract Try |
POST/commercial/upgrade-opportunities/{uid}/interactions |
Record a bounded interaction with one product-led upgrade opportunity | commercial:write |
Developer & Commercial | Contract Try |
GET/commercial/usage |
Read normalized FinanceGPT commercial usage and allowances | commercial:read |
Developer & Commercial | Contract Try |
GET/actions/agentic |
Read machine financial identities, delegations, signed actions and kill switches | actions:read |
Financial Actions | Contract Try |
POST/actions/agentic/delegations/{uid}/approve |
Independently approve a machine financial delegation | actions:execute |
Financial Actions | Contract Try |
POST/actions/agentic/delegations/{uid}/revoke |
Revoke a machine delegation and release open reservations | actions:execute |
Financial Actions | Contract Try |
POST/actions/agentic/identities |
Register a versioned machine financial identity | actions:create |
Financial Actions | Contract Try |
POST/actions/agentic/identities/{uid}/activate |
Activate a machine financial identity after verification | actions:create |
Financial Actions | Contract Try |
POST/actions/agentic/identities/{uid}/delegations |
Create a bounded machine financial delegation | actions:create |
Financial Actions | Contract Try |
POST/actions/agentic/identities/{uid}/versions |
Record a new machine financial-identity version | actions:create |
Financial Actions | Contract Try |
POST/actions/agentic/kill-switches |
Engage a workspace, machine-identity or delegation execution kill switch | actions:execute |
Financial Actions | Contract Try |
POST/actions/agentic/kill-switches/{uid}/release |
Release a machine financial kill switch | actions:execute |
Financial Actions | Contract Try |
POST/actions/agentic/proposals |
Submit an Ed25519-signed machine Financial Action proposal | actions:create |
Financial Actions | Contract Try |
POST/actions/agentic/{uid}/execute |
Execute a machine-delegated Financial Action using a fresh signed execution instruction | actions:autonomous |
Financial Actions | Contract Try |
GET/actions/approval-graphs |
List governed Financial Action approval graphs | actions:read |
Financial Actions | Contract Try |
GET/actions/assurance |
Read workspace Financial Actions assurance status | actions:read |
Financial Actions | Contract Try |
POST/actions/assurance/runs |
Run the workspace Financial Actions assurance suite | actions:execute |
Financial Actions | Contract Try |
GET/actions/authorities |
List active and historical action-scoped authorities for the workspace | actions:read |
Financial Actions | Contract Try |
GET/actions/autonomy |
Read restricted institutional autonomous-operations status | actions:read |
Financial Actions | Contract Try |
POST/actions/autonomy/application |
Request institutional assessment for autonomous financial operations | actions:create |
Financial Actions | Contract Try |
POST/actions/autonomy/assessment-evidence |
Submit evidence to an open institutional autonomy assessment | actions:create |
Financial Actions | Contract Try |
POST/actions/autonomy/institutional-mandates |
Create a draft restricted autonomous financial mandate | actions:create |
Financial Actions | Contract Try |
POST/actions/autonomy/institutional-mandates/{uid}/submit |
Submit a restricted autonomous mandate for FinanceGPT platform approval | actions:create |
Financial Actions | Contract Try |
GET/actions/counterparties |
List governed Financial Action counterparties and current settlement-destination status | actions:read |
Financial Actions | Contract Try |
GET/actions/credit-corporate |
List governed credit, collections and corporate-action links | actions:read |
Financial Actions | Contract Try |
POST/actions/credit-corporate |
Create a governed credit, collection or corporate action from a sealed source record | actions:create |
Financial Actions | Contract Try |
GET/actions/credit-corporate/arrangements |
List accepted settlement and repayment arrangements | actions:read |
Financial Actions | Contract Try |
POST/actions/credit-corporate/arrangements |
Register an accepted settlement or repayment arrangement | actions:create |
Financial Actions | Contract Try |
GET/actions/credit-corporate/instructions |
List governed corporate and treasury instructions | actions:read |
Financial Actions | Contract Try |
POST/actions/credit-corporate/instructions |
Register a governed corporate instruction | actions:create |
Financial Actions | Contract Try |
GET/actions/credit-corporate/obligations |
List governed credit and collection obligations | actions:read |
Financial Actions | Contract Try |
POST/actions/credit-corporate/obligations |
Register a governed obligation source record | actions:create |
Financial Actions | Contract Try |
POST/actions/credit-corporate/{uid}/checks |
Record a versioned credit, collection or corporate-action domain control | actions:execute |
Financial Actions | Contract Try |
POST/actions/credit-corporate/{uid}/refresh |
Refresh source-record scope and invalidate stale approval when material evidence changed | actions:execute |
Financial Actions | Contract Try |
GET/actions/execution-instructions |
List governed Payments & Treasury execution instructions | actions:read |
Financial Actions | Contract Try |
GET/actions/execution-profiles |
List Payments & Treasury execution profiles and engaged kill switches | actions:read |
Financial Actions | Contract Try |
GET/actions/intents |
List governed Financial Action envelopes for the active workspace | actions:read |
Financial Actions | Contract Try |
POST/actions/intents |
Create a governed Financial Action envelope | actions:create |
Financial Actions | Contract Try |
GET/actions/intents/{uid} |
Read one Financial Action envelope and current control-plane state | actions:read |
Financial Actions | Contract Try |
GET/actions/intents/{uid}/approval-run |
Read the current Financial Action approval run and quorum progress | actions:read |
Financial Actions | Contract Try |
GET/actions/intents/{uid}/evidence |
Read structured Financial Action control and evidence lineage | actions:read |
Financial Actions | Contract Try |
POST/actions/intents/{uid}/execute |
Execute an authorized Financial Action through its separate execution authority | actions:execute |
Financial Actions | Contract Try |
POST/actions/intents/{uid}/reconcile |
Reconcile an executed Financial Action against settlement evidence | actions:read |
Financial Actions | Contract Try |
POST/actions/intents/{uid}/submit |
Submit a Financial Action for governed human approval | actions:create |
Financial Actions | Contract Try |
GET/actions/investment-execution |
List investment order batches converged into governed Financial Actions | investment:read |
Financial Actions | Contract Try |
POST/actions/investment-execution |
Adopt an investment order batch into the Financial Actions control plane | investment:execute |
Financial Actions | Contract Try |
GET/actions/investment-execution/{uid} |
Read one governed investment execution convergence record | investment:read |
Financial Actions | Contract Try |
POST/actions/investment-execution/{uid}/checks |
Record a versioned investment pre-trade control result | investment:execute |
Financial Actions | Contract Try |
POST/actions/investment-execution/{uid}/confirmations |
Record broker trade-confirmation evidence without treating it as settlement | investment:execute |
Financial Actions | Contract Try |
POST/actions/investment-execution/{uid}/custody |
Record independent custody settlement evidence and run canonical reconciliation | investment:execute |
Financial Actions | Contract Try |
POST/actions/investment-execution/{uid}/refresh |
Refresh material investment-order scope and invalidate stale approval when needed | investment:execute |
Financial Actions | Contract Try |
GET/actions/policies |
List scoped Financial Actions policies and conditional rules | actions:read |
Financial Actions | Contract Try |
GET/actions/reconciliation |
List Financial Action settlement and reconciliation status | actions:read |
Financial Actions | Contract Try |
GET/actions/reconciliation-exceptions |
List Financial Action reconciliation exceptions | actions:read |
Financial Actions | Contract Try |
POST/actions/reconciliation-exceptions/{uid}/resolve |
Resolve a Financial Action reconciliation exception with retained evidence | actions:execute |
Financial Actions | Contract Try |
GET/actions/risk-rules |
List active and historical dynamic Financial Action risk rules | actions:read |
Financial Actions | Contract Try |
GET/data/instruments/{uid}/corporate-actions |
Get normalized corporate actions | data:market:read |
Financial Data & Planning | Contract Try |
GET/financial/transactions |
List normalized connected financial transactions | financial:read |
Financial Data & Planning | Contract Try |
POST/lqm/evidence-packets/{packetUid}/verify |
Independently verify an LQM Evidence Packet and model evidence chain | lqm:build:run |
LQM Builder | Contract Try |
POST/lqm/models/{uid}/promote |
Promote an evaluated LQM checkpoint into Quant Models | lqm:promote:write |
LQM Builder | Contract Try |
GET/lqm/platform |
Read the governed LQM Builder platform foundation | lqm:build:read |
LQM Builder | Contract Try |
GET/agent-execution/workflows |
List published immutable Workflow Studio tools allowed for the signed external agent | agent:execution:read |
Workflows | Contract Try |
GET/agent-execution/workflows/runs/{uid}/outcome |
Read measured workflow outcome evidence | agent:execution:read |
Workflows | Contract Try |
POST/agent-execution/workflows/tools/{uid}/runs |
Invoke a published immutable production workflow | agent:execution:invoke |
Workflows | Contract Try |
PUT/workflow-studio/qos/policy |
Update workspace weighted-fair dispatch and queue-age QoS policy | workflow:manage |
Workflows | Contract Try |
POST/workflow-studio/runs/{uid}/{action} |
Pause, resume, cancel or replay a durable workflow run | workflow:manage |
Workflows | Contract Try |
POST/workflow-studio/validation-campaigns/{uid}/review |
Explicitly approve or reject a high-risk workflow change after successful validation | workflow:manage |
Workflows | Contract Try |
POST/workflow-studio/versions/{uid}/validate |
Run a side-effect-free S16 validation campaign against an exact draft or testing version | workflow:manage |
Workflows | Contract Try |
POST/finance-core/actions/journals/post |
Post an FC2 journal from a matching FC10 authorization | Public / authentication-specific | Other | Contract Try |
POST/finance-core/actions/periods/{periodUid}/lock |
Lock an accounting period after certified close and FC10 authorization | Public / authentication-specific | Other | Contract Try |
POST/finance-core/actions/reconciliations |
Record an FC4 reconciliation from a matching FC10 authorization | Public / authentication-specific | Other | Contract Try |
POST/finance-core/actions/recommendations/{recommendationUid}/approve |
Record an FC10 accounting-control approval as the delegated human actor | Public / authentication-specific | Other | Contract Try |
POST/finance-core/actions/recommendations/{recommendationUid}/authorize |
Create a non-executing FC10 manual action authorization | Public / authentication-specific | Other | Contract Try |