Skip to main content
GET
Get a customer's AML status
Returns only the AML compliance block from the customer record. Useful for reporting integrations that hold the narrower aml:read scope instead of customers:read.

Identifier

The {id} path parameter accepts either form:
  • Instant Compliance UUID — e.g. 550e8400-e29b-41d4-a716-446655440000
  • Your own external_id — e.g. crm-7741
The format is detected automatically — no flag needed. Use whichever your CRM has on hand.

Why a sub-resource?

So you can issue a reporting-only key with the minimal scope aml:read. Such a key cannot enumerate customer identity — it can only fetch AML status for ids you already know.

Status semantics

See Customer lifecycle → AML status.

Examples

By UUID:
By external_id:

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers in your Instant Compliance organisation. Format: ic_live_….

Path Parameters

id
string
required

Customer identifier. Accepts either Instant Compliance's UUID (550e8400-…) or your own external_id — the format is detected automatically.

Response

AML status block.

status
enum<string>
required
Available options:
NOT_SCREENED,
IN_PROGRESS,
CLEAR,
NEEDS_REVIEW,
RESOLVED
flags
object
required
screened_at
string<date-time> | null
last_reviewed_at
string<date-time> | null