Screening and document reading

Version: 0.1.2
Database part: Yes

The contract

Takes a name or a document. Returns sanctions matches or the text read from it.

Settings

Name	What it does
providerUrl	The OpenSanctions address, such as https://api.opensanctions.org, passed to screenSubject as baseUrl. Nothing is cleared without it.
dailyCap	The most paid screening calls, and separately the most paid reads, in one UTC day. Retries count. Defaults to 50.
threshold	A score at or above this is a match. Defaults to 0.8.
reviewFloor	A score at or above this and below the threshold is a possible match for a reviewer. Defaults to 0.7.
topics	The list topics screened against. Defaults to sanctions, politically exposed persons, crime, debarment and enforcement topics.
dataset	The OpenSanctions dataset or collection screened. Defaults to default.
limit	How many results one request asks for, up to 200. Defaults to 50. A full page holds the check for review.
algorithm	The provider's matching algorithm, pinned so scores can be reproduced. Defaults to logic-v2.
maxAttempts	Tries per check, up to 5. Each one counts against the daily cap. Defaults to 3.
timeoutMs	How long one try may take, in milliseconds. Defaults to 30000.
reader	The app's own function that reads text from a PDF or an image, passed to readDocument. Needed only for document reading.
maxBytes	The largest document readDocument reads, in bytes. Defaults to 10 MB, at most 25 MB.

Requires

Live demo

Screen a name

The real block runs here. The list provider and the database are stood in for, so nothing is sent and nothing is stored. The answer depends on the scenario you pick, not on the name you type.

Who is screened

A person

An organisation

Name

Name in its own script

Other names, one on each line

Names that would be sent

Anna Maria Eriksson (Latin)

What the provider sends back

A match at or above

Held for review at or above

Paid calls today 0 of 6. Every retry counts.

Read the zone at the foot of a passport

The two lines of code are read without any model, and each check digit is tested. The name is in Latin letters, so a person whose printed name is in another script can be screened under both.

Text read from the document

Every check digit agrees.

Name: ANNA MARIA ERIKSSON
Document number: L898902C3
Nationality: UTO
Date of birth: 1974-08-12
Expiry: 2012-04-15
Checks that agree: 4 of 4