DOAML API (0.1.0)

Screen crypto transactions, wallets and names for AML risk.

Getting started

  1. In the DOAML app, open the API page of your workspace and create a key. The key is shown only once.
  2. Send it in every request: Authorization: Bearer doaml_....
  3. Use the workspace slug from the app URL (https://doaml.com/w/{slug}/...) in the path.
curl https://api.doaml.com/w/acme-compliance/wallets \
  -H "Authorization: Bearer doaml_..."

An API key belongs to one workspace and has the member role. This reference lists only operations that API keys can call. Admin tasks such as managing users, API keys and settings are done in the DOAML app.

Screening is asynchronous

Submitting a transaction or an entity returns 202 with the new resource ID. Poll the matching GET operation until status is completed or failed. Statuses go pending → processing → completed or failed. A transaction with parties stays pending until their screenings finish. Wallets are checked in the background on a schedule; read their latest check with GET /w/{slug}/wallets/{id}. An accepted request is not a clearance decision.

Pagination

Most list operations take limit (1-100, default 20) and offset (default 0) and return meta.total with the total number of items. Lists that page differently say so.

Errors

Errors return JSON like {"status": 404, "message": "workspace not found"}. Some errors add a machine-readable code. A request that does not match this specification (wrong type, value out of range, invalid JSON) returns 400 with {"error_message": "..."} instead.

StatusCodeMeaning
400The request is invalid; message says why.
401The API key is missing, wrong or expired.
402account_expired, account_suspended, account_pendingThe account cannot be used now.
402trial_limit_reachedA trial limit was reached; limit names it.
403The key has no access to this workspace or operation.
404The workspace or resource does not exist.
409The request conflicts with the current state, for example a stale version.
429, 503Temporary; retry later.

Other statuses are described on each operation.

Servers
Production API
https://api.doaml.com