Skip to main content
The End User Onboarding API lets you create and manage onboarding applications for your customers. Collect business data, upload documents, and submit applications for compliance review through one REST API. This removes manual steps as you scale. Use the End User Onboarding API to onboard your end users (the merchants and customers you serve) to Managed Payments. Circle performs Know Your Business (KYB) verification on each end user, and the End User Onboarding API submits that KYB data programmatically, so you onboard end users through the API instead of offline channels. The API covers the full application lifecycle, from draft through approval, including Requests for Information (RFIs) when the compliance team needs more data.
Managed Payments serves two customer types: you (the distributor) and your end users. You access Managed Payments and obtain API keys through the CPN Console. Your end users onboard through the End User Onboarding API, which uses the same API structure for both customer types.

​
Key features

Schema-driven forms

Retrieve a JSON Schema that defines required fields, validation rules, and conditional dependencies.

Bulk data submission

Submit all sections in one call. The API validates first, then saves each in order.

Document management

Upload, list, and delete documents. Files link to the relevant application fields and entities.

​
What you can build

Build onboarding forms in your platform. Use the JSON Schema to render fields and conditional sections. Your customers stay in your app the whole time.
Migrate existing customers by creating applications and submitting data in bulk. One request per application fills all sections at once.
Surface RFIs to your operations team or to customers. Webhook notifications drive real-time updates and automate follow-ups.

​
How it works

1

Create a draft application

You create a draft application for your customer. It starts in DRAFT status with a schema that lists the required fields.
2

Collect data and documents

You save section data and upload documents. The API validates each submission against the schema.
3

Submit for compliance review

When all sections are complete, you submit the application. Circle’s compliance team reviews it and either approves it or issues requests for information (RFIs).
4

Handle RFIs and resubmit

If the team requests more data, you update the sections or documents and resubmit. The application moves through statuses until it reaches a final state.

​
Get started

Submit onboarding application

Walk through an application end to end in sandbox

Application states

Learn the statuses an application moves through

Create and populate applications

Walk through the full application lifecycle

Handle requests for information

Respond to compliance team RFIs and resubmit