Skip to main content
GET
Get an entity's AML status
AML compliance sub-resource for entity customers. Returns only the AML status and category flags — useful for reporting-only integrations that hold the narrower aml:read scope instead of customers:read. The block is identical in shape to the individual customer AML sub-resource; for entities it reflects the business-level screening (sanctions, adverse media) run during KYB.

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

Entity 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