RESTful APIs with comprehensive webhooks, real-time events, and full programmatic control. Build anything.
Clean, consistent APIs designed for developers. From authentication to webhooks, every detail is thoughtfully crafted.
Clean JSON REST API at api.ferros.xyz/v1. Consistent resource patterns for wallets, transactions, vaults, workflows, and policies. Standard HTTP methods with predictable URL structures.
14 event types covering the full transaction lifecycle, vault activity, workflow triggers, and infrastructure alerts. Every payload is HMAC-SHA256 signed for verification.
Generate, rotate, and revoke API keys through the dashboard or API. SHA-256 hashed storage ensures keys are never stored in plaintext. Prefixed with cv_ for easy identification.
API Key via X-API-Key header for server-to-server integration. JWT Bearer token for user sessions with embedded userId, orgId, and role claims. Choose the right auth model for each use case.
Every entity in the Ferros platform is a first-class API resource. Wallets, transactions, vaults, workflows, addresses, and signing requests are all accessible via consistent REST patterns.
All endpoints return wrapped responses with consistent error handling, pagination metadata, and predictable HTTP status codes.
| Method | Path | Description |
|---|---|---|
| GET | /v1/wallets | List wallets (paginated) |
| POST | /v1/wallets | Create wallet |
| GET | /v1/transactions | List with status/chain filters |
| POST | /v1/transactions | Create transaction |
| POST | /v1/transactions/:id/approve | Approve transaction |
| POST | /v1/transactions/:id/execute | Execute on-chain |
| GET | /v1/vaults | List vaults (paginated) |
| POST | /v1/vaults | Create vault + wallets |
| POST | /v1/workflows/:id/activate | Activate workflow |
| POST | /v1/workflows/:id/run | Manual trigger |
| POST | /v1/addresses | Generate via HD derivation |
| POST | /v1/signing-requests/:id/signature | Submit signature |
Every webhook payload is signed with HMAC-SHA256 using your webhook secret. Verify the X-Ferros-Signature header to ensure payloads are authentic and untampered.
Compute HMAC of the raw payload body using your webhook secret. Compare with the signature header.
Every event includes event type, timestamp, resource ID, and full resource data in a consistent JSON envelope.
Failed deliveries are retried with exponential backoff. Webhook status is tracked and surfaced in the dashboard.
Send a test event to any registered webhook endpoint via the API or dashboard to validate your integration.
Register a webhook and start receiving real-time events in minutes. Every payload is signed and verifiable.
curl https://api.ferros.xyz/v1/webhooks \ -H "X-API-Key: cv_live_..." \ -H "Content-Type: application/json" \ -d '{ "url": "https://your-app.com/webhooks/ferros", "events": [ "transaction.created", "transaction.completed", "transaction.failed", "vault.deposit", "gas_tank.low" ] }'
{ "event": "transaction.completed", "timestamp": "2025-01-15T09:32:17Z", "data": { "id": "tx_8f3k2j1...", "status": "COMPLETED", "type": "SEND", "chain": "ETHEREUM", "amount": "1.5", "txHash": "0xabc123...", "walletId": "wlt_9d2m...", "confirmations": 12 } }
The Ferros API powers every product in the platform. Explore related capabilities.
Programmatic wallet creation with HD derivation, multi-sig, and custodial or self-custody modes.
Learn moreConfigurable policies, multi-level approvals, immutable audit logs, and AES-256-GCM encryption.
Learn moreTrigger-based automation with visual editor. Forward funds, split payments, and send notifications.
Learn moreGet your API key and start integrating in minutes. Full documentation, code examples, and webhook testing included.
