Introduction
Covalent exposes a REST API for Travel Rule workflows. It takes API keys only, works in the environment of the key, and covers customers, wallets, transfers, compliance casework and reporting, configuration and webhooks.
Integration Path
Section titled “Integration Path”| Step | What You Do | API Surface |
|---|---|---|
| 1 | Create an API key | Dashboard: Developers, API keys |
| 2 | Create a customer | POST /api/v2/customers |
| 3 | Set the customer's attested identity | PUT /api/v2/customers/:id/travel-rule-identity |
| 4 | Register a wallet under that customer | POST /api/v2/wallets |
| 5 | Create an outgoing transfer | POST /api/v2/transfers |
| 6 | Track transfer state | GET /api/v2/transfers/:id, or webhooks |
| 7 | Act on held or failed transfers | PATCH /api/v2/transfers/:id |
Resources
Section titled “Resources”| Resource | Purpose |
|---|---|
| Customers | Your end users, and their attested Travel Rule identity |
| Wallets | The registry of your customers' addresses |
| Transfers | Travel Rule transfers, outgoing and incoming |
| VASP Search | The counterparty VASPs of your environment |
| Assets | The asset catalog, and which assets you accept |
| Cases | Compliance cases |
| Reports | Regulatory reports, read and downloaded as PDF |
| Rules and Thresholds | Compliance rules and regulatory thresholds |
| Providers and Integrations | Travel Rule provider and screening integration settings |
| Webhooks | Subscriptions, and signed events for transfers and cases |
| Activity and Audit Log | What happened, and the audit record |
Boundaries
Section titled “Boundaries”- Each API key belongs to the
testorliveenvironment, and every request works in that environment only. - A key acts for the member who created it: its scopes are cut to that member's role each time it is used.
- Covalent carries transfers through five Travel Rule providers (Notabene, CodeVASP, Veriscope, Global Travel Rule and Sygna Bridge) and screens them with four integrations (Elliptic, TRM Labs, ComplyAdvantage and Crystal Intelligence), as your company configures them.
- API keys, team members, promoting rules to live, and drafting and filing reports are managed in the dashboard.
Base URL
Section titled “Base URL”The API is served from your company's own host, https://<company>.<app-domain>: the address your dashboard opens at. See Base URL.