API versions and Beta status
Learn what the Roots Beta API supports today and what to verify before using a workflow in production.
Understand what the Roots Beta API supports today and what you must verify before using a workflow in production.
Beta API status
Roots is actively developing the Beta API. Endpoints, schemas, authentication requirements, response formats, and lifecycle states can change before a stable production release.
Use the Beta documentation to plan your integration and validate current schemas. Before processing live funds, confirm the production API contract and the capabilities enabled for your company with Roots.
Current availability
The following front-office capabilities are currently available in the API reference:
- Authentication
- User management
- API-key management
The following operational resources are currently marked Coming soon. Their documented endpoints return mocked data and do not require authentication:
- Persons and associations
- Documents
- Accounts
- Counterparties
- Payments
- Requests and RFIs
- Trades
How to use Beta documentation
Use the documented schemas to design data models, integration flows, and internal operations. Do not assume that a field marked optional in a mock schema will be optional in the production contract.
Before enabling a workflow, confirm its released contract in the API reference, including:
| Workflow | Confirm with Roots |
|---|---|
| Onboarding | Required data, documents, submission flow, review outcomes, and authentication. |
| Accounts | Issuance conditions, account states, account instructions, balance behavior, and enabled currencies. |
| Counterparties | Required destination data, screening outcomes, supported rails, and update behavior. |
| Payments | Request fields, idempotency, status transitions, failures, returns, limits, and settlement events. |
| RFIs | Response endpoint, document requirements, due dates, notifications, and effects on linked activity. |
| Webhooks | Event types, endpoint registration, signature verification, retries, ordering, and replay behavior. |
Production safeguards
Do not process live funds until Roots has confirmed that the applicable product, currency, payment rail, jurisdiction, and production capability are enabled for your company.
Your integration must also:
- Treat an account, counterparty, review, or payment response as non-final until its current lifecycle status permits the next action.
- Use available balance—not current balance alone—to determine whether funds can be used.
- Stop automated activity when Roots reports an RFI, hold, restriction, blocked state, or non-terminal payment state.
- Store Roots IDs and your own external references for reconciliation.
- Verify production behavior after the API is released; do not rely on mock responses for money movement.
Versioning path
Roots will use Beta documentation while operational behavior is still evolving. A stable production version should identify its supported contract and deprecation policy before it is labeled v1.
Next steps
- Start with Quickstart to create and manage access.
- Read Core concepts to understand Roots objects and lifecycles.
- Use Production readiness before enabling a live integration.
- Review the API reference for the current schema.
Updated about 1 hour ago