canonical: https://jentic.com/apis/fordefi.com/fordefi

# Fordefi API

Jentic publishes the only available OpenAPI specification for Fordefi API, keeping it validated and agent-ready. Fordefi is an institutional MPC wallet platform and web3 gateway used by builders, traders, and operators to self-custody private keys, connect to dApps across blockchains, and apply granular policies to digital asset operations. The API exposes endpoints for transactions, vaults, assets, end users, user groups, blockchains, webhooks, and authorization tokens. Authentication is bearer-token based.

## For AI agents

Manage MPC vaults, sign and submit blockchain transactions, look up assets, and configure webhooks across the Fordefi institutional web3 platform from agent code.

## Scope

Does not handle fiat banking, accounting, or DeFi protocol-specific actions - use for Fordefi MPC vault, transaction signing, user, and webhook operations only.

## Capabilities

- Create and inspect MPC vaults that hold institutional digital assets
- List vault assets and their balances across supported blockchains
- Submit transactions for MPC signing through Fordefi's policy engine
- Manage end users and user groups for role-based access
- Issue and rotate authorization tokens used by automated systems
- Configure webhooks to receive transaction and policy events
- List supported blockchains and read suggested fees before signing

## Use cases

### Programmatic Treasury Operations

Automate institutional treasury workflows by submitting transactions through Fordefi's MPC signing pipeline. Use POST `/api/v1/vaults` to provision vaults, list assets via `/api/v1/vaults/{id}/assets`, and submit signing requests through the transactions endpoints under policy controls. Suits crypto-native businesses that need auditable, policy-bound on-chain operations rather than hot-wallet scripts.

Example prompt: List vaults via GET `/api/v1/vaults`, pick the one named 'Treasury USDC', and submit a signing request for a USDC transfer to a specified destination address.

### End User and Permission Management

Provision teammates and partner users via `/api/v1/users` and group them through `/api/v1/user-groups` so each role only touches the vaults it should. This is critical for institutions that need separation of duties between traders, operators, and approvers. Each user and group is referenced by ID elsewhere in the API for policy attachments.

Example prompt: Create a user with the supplied email and add them to the 'Trading' user group via `/api/v1/user-groups.`

### Asset and Fee Discovery

Read `/api/v1/blockchains` and `/api/v1/blockchains/suggested-fees` before constructing a transaction so the agent picks an appropriate gas or fee setting per chain. Combined with `/api/v1/vaults/{id}/assets`, this gives a complete view of what a vault holds and what it will cost to move it. The endpoints are read-only and safe to call frequently.

Example prompt: Call GET `/api/v1/blockchains/suggested-fees` for the 'ethereum' chain and return the suggested gas tip and base fee.

### Webhook-Driven Operations

Register webhooks via the webhooks endpoints so Fordefi notifies your systems when transactions enter signing, complete, or fail policy checks. Useful for ops dashboards, compliance archives, and chat notifications. Webhooks receive structured event payloads and reference the transaction or vault ID for cross-lookup.

Example prompt: Create a webhook subscription that posts transaction-completed events to a specified HTTPS endpoint.

### AI Agent Treasury Integration via Jentic

Agents use Jentic's intent search to find Fordefi operations, load the schema for vault listing or transaction submission, and execute calls under a scoped credential. This is the recommended pattern for assistants used by treasury teams to inspect balances or queue transfers - Jentic keeps the bearer credential isolated and out of the agent's context.

Example prompt: Use Jentic to search 'list Fordefi vaults', load the GET `/api/v1/vaults` schema, and return the names and IDs of vaults that hold the asset the user named.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/vaults` | List vaults in the tenant |
| GET | `/api/v1/vaults/{id}` | Retrieve a vault by ID |
| GET | `/api/v1/vaults/{id}/assets` | List assets in a vault |
| GET | `/api/v1/blockchains` | List supported blockchains |
| GET | `/api/v1/blockchains/suggested-fees` | Read suggested fees for a chain |
| GET | `/api/v1/users` | List users |
| GET | `/api/v1/user-groups` | List user groups |

## Key resources

- **Vaults** — Create and inspect MPC vaults and the assets they hold.
- **Transactions** — Submit and look up MPC-signed transactions.
- **Assets** — Read asset metadata across supported chains.
- **Authorization Tokens** — Issue and rotate API tokens used by automated systems.
- **Keysets** — Manage MPC keysets that back vaults.
- **End Users** — Provision external users that interact with the platform.
- **Users** — Manage internal users.
- **User Groups** — Group users for policy and access management.
- **Blockchains** — List supported chains and read suggested fees.
- **Webhooks** — Register webhook subscriptions for transaction and policy events.

## Why Jentic

- **Setup:** Wiring the Fordefi API by hand means managing its bearer token and building your own retry and error handling across vault, transaction, user, and webhook endpoints. Through Jentic you install once, import Fordefi from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Fordefi puts the vault id in the URL path (`/api/v1/vaults/{id}/...`), so a rule can pin your agent to one vault: it can read that vault and its assets and nothing else. You choose the operations it may call, so transaction-signing operations are not included unless you add them.
- **Credential handling:** Your Fordefi bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list Fordefi vaults', and Jentic returns the GET `/api/v1/vaults` operation with its query schema so the agent inspects the right vaults without browsing the reference docs.

## Related APIs

- **Plaid API** — Bank account data for fiat-side treasury operations alongside Fordefi's crypto custody.
- **Stripe API** — Fiat payments to pair with Fordefi's crypto-side custody and signing.
- **Auth0 API** — Identity provider that can front Fordefi's end-user provisioning.

## FAQ

### Why is there no official OpenAPI spec for Fordefi API?

Fordefi publishes reference docs but the only structured OpenAPI specification has been generated and maintained by Jentic so AI agents and developers can call Fordefi API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Fordefi API use?

The Fordefi API uses HTTP bearer authentication with a long-lived API token issued from the Fordefi console. Jentic stores the token encrypted in your Jentic One instance and constructs the Authorization: Bearer header on outbound calls.

### Can I list vault balances with the Fordefi API?

Yes, GET `/api/v1/vaults/{id}/assets` returns the assets held in a specific vault, and GET `/api/v1/vaults` lists vaults so you can resolve the right ID first. Combine with `/api/v1/blockchains` for chain metadata.

### What are the rate limits for the Fordefi API?

The OpenAPI spec does not declare explicit rate limits. Fordefi applies tenant-level throughput controls in production - back off on 429 responses and avoid polling vault balances at sub-second intervals.

### How do I submit a transaction for MPC signing through Jentic?

Search Jentic for 'submit a Fordefi transaction', load the relevant POST schema under `/api/v1/transactions`, and execute with the source vault, destination address, asset, and amount. Fordefi's policy engine then approves or rejects the signing request.

### Does the Fordefi API support webhooks for transaction events?

Yes, the webhooks endpoints let you register HTTPS subscribers that receive transaction lifecycle and policy events. Use this to drive ops dashboards or to archive every signing decision for audit.

### Can I limit what my agent is allowed to do with the Fordefi API?

Yes. Because you run Jentic One yourself, your own rules decide which Fordefi operations and credentials the agent may use. Since Fordefi puts the vault id in the URL path (`/api/v1/vaults/{id}/assets`), you can pin the agent to a single vault so it only reads that vault and its assets. You also choose the exact operations it may call, so transaction-signing endpoints under `/api/v1/transactions` stay off limits unless you explicitly grant them.