IDCanopy Developers
Umbrella API

AML light

Individual screening and ongoing monitoring against sanctions, PEP and criminal lists

This page documents AML light, the tier the published specification describes. Extended AML screening is a separate, upcoming section, not a revision of this one.

What it returns

A list of matching records (sanctions, PEP, criminal) for a searched individual, plus tools to register or remove individuals and entities from ongoing monitoring.

Extended AML screening is a separate, upcoming section.

Request

POST /aml/checkIndividual

FieldRequiredDescription
nameyesSearch string checked against name fields
dobnoDate of birth, yyyy/mm/dd

POST /aml/ongoingMonitoring/registerEntity

FieldRequiredDescription
profileIdyesUnique identifier for the entity profile
namesyesFull name of the entity
searchAllnoCannot be combined with names
fuzzySearchnoEnables fuzzy search

POST /aml/ongoingMonitoring/registerIndividual

FieldRequiredDescription
profileIdyesUnique identifier for the individual profile
namesyesFull name of the individual
genderno
dobno
searchAllnoCannot be combined with names
fuzzySearchno

POST /aml/ongoingMonitoring/removeSearchProfile

FieldRequiredDescription
profileIdyesUnique identifier for the profile to remove

Response

checkIndividual returns totalHits and foundRecords[], each with sourceType (SANCTION, PEP, CRIMINAL), pepType, entityType, name, aliasNames, dateOfBirth, citizenship, occupations, positions, politicalParties, links.

Decision

The caller decides from foundRecords, an empty array means no hit; each record's sourceType and pepType carry the reason for a match.

Test cases

Pending.

Reference

Umbrella API reference.

On this page