Corgi BankDocumentation
OpenAPI

The Screening object

A name screened against the sanctions lists: clear, review or hit, with the matches.

Attributes

idstringRequired

Example scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm

list_age_daysintegerRequired

The oldest list's age on the day of the screening

list_stalebooleanRequired

A list had gone past the staleness threshold without a download; the screening still ran

list_versionstringRequired

The versions of the lists, in the order of Lists

list_versionsarray of objectsRequired
7 child attributes
age_daysintegerRequired

Days since publication

entriesintegerRequired
fetch_age_daysintegerRequired

Days since the list's files were last downloaded

hashstringRequired
idstringRequired
published_onstringOptional
versionstringRequired
listsstringRequired
matchesarray of objectsRequired
5 child attributes
alias_typestringRequired

Primary, strong or weak

dob_matchbooleanOptional
list_idstringRequired
matched_namestringRequired
scorenumberRequired
namestringRequired
resultstringRequired
unreadable_scriptbooleanOptional

UnreadableScript is set when the name has letters of a script the matcher cannot read; the result is then a potential match for a person, never clear.

to move to open esc to close