Skip to main content
Hosted docs: https://cop-by.mintlify.app (also linked from Partners → Docs). Start with a server-side integration key. Then choose one product guide; their transaction and custody models are intentionally different.
1

Create an integration key

Open Partners → API keys and create a key for your organization. Store it on your backend as COPBY_API_KEY; never expose it in a browser or mobile bundle.
2

Choose a product

3

Start the local API

Contributors can run the API from the repository root:
The Integrations API listens on http://localhost:3000.
4

Start the docs

Open http://localhost:3333. Mint uses port 3333 so it does not collide with Next.
5

Call the API

Open API reference, select an endpoint, choose the Local or Production server, and enter the integration key in Authorization.
Keep one idempotency key across network retries. Generate a new key only for a new user action.

Authentication

Learn key storage, organization isolation, and playground setup.

Errors and lifecycle

Add safe retries and reconciliation before going live.