Skip to main content
GET
/
customers
/
{id}
/
aml
Get a customer's AML status
curl --request GET \
  --url https://app.instantcompliance.ai/api/v1/customers/{id}/aml \
  --header 'Authorization: Bearer <token>'
{
  "flags": {
    "pep": true,
    "sanctions": true,
    "adverse_media": true,
    "terrorism": true
  },
  "screened_at": "2023-11-07T05:31:56Z",
  "last_reviewed_at": "2023-11-07T05:31:56Z"
}
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: 
curl https://app.instantcompliance.ai/api/v1/customers/550e8400-e29b-41d4-a716-446655440000/aml \
  -H "Authorization: Bearer ic_live_..."
By external_id: 
curl https://app.instantcompliance.ai/api/v1/customers/crm-7741/aml \
  -H "Authorization: Bearer ic_live_..."

{
  "status": "CLEAR",
  "screened_at": "2026-06-23T01:12:00Z",
  "last_reviewed_at": null,
  "flags": {
    "pep": false,
    "sanctions": false,
    "adverse_media": false,
    "terrorism": false
  }
}

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