Overview

Choose an evaluation path or integration path for the Roots Beta API.

⚠️
Roots is actively developing the Beta API. See API availability before using a workflow in production.

Evaluate Roots

Use these pages to assess product scope, compliance operating model, and launch requirements.

Platform capabilities

Review customer types, jurisdictions, USD accounts, Fedwire, internal transfers, and compliance workflows.

How compliance works

Understand the Roots and partner-bank decision model, RFIs, holds, and review lifecycle.

Production readiness

Validate access, lifecycle handling, reconciliation, and production capability enablement.

Build with Roots

Use these pages to scope and build your integration.

Quickstart

Create a front-office session and generate an API key for your company.

Core concepts

Learn the Roots object model, lifecycle states, balances, and compliance controls.

API reference

Explore the current UAT endpoints, schemas, parameters, and responses.

Onboard a business end customer

Model a business and its associated people for review.

Manage accounts

Create accounts and enforce account-state and available-balance controls.

Create payments

Create payment instructions, then track and reconcile their outcomes.

Integrate safely

Read Authentication before managing front-office access and API keys.
Read Errors, Idempotency, and Rate limits before adding automated retries.
Read Webhooks and events before designing event-driven workflows.
Read Security and data handling before handling customer or payment data.

API resources

The API reference is the source of truth for the released UAT schema. Use API availability to understand the status of each resource and which production details still require confirmation.