Screening a person
POST /v1/screenings screens one person synchronously. The p95 latency target is under 350 ms.
Request fields
Section titled “Request fields”| Field | Required | Description |
|---|---|---|
full_name |
Yes | Full name in Latin script, in any order. Max 300 characters. |
date_of_birth |
No | YYYY-MM-DD, YYYY-MM or YYYY. Improves precision. |
country |
No | ISO 3166-1 alpha-2. Stored for your records; does not affect the score yet. |
external_id |
No | Your id for the person. Needed for whitelisting and future ongoing monitoring. |
sources |
No | Source ids to search instead of the project defaults, for example ["un_sc", "in_mha"]. |
metadata |
No | Up to 20 string key-value pairs, returned unchanged in responses and webhooks. |
entity_type |
No | Only person is supported. organization is reserved for the future. |
Name input
Section titled “Name input”Send the name exactly as you have it, in one string. You do not need to split it into parts or put it in a particular order.
- Titles and honorifics (
Mr,Mrs,Dr,Sirand others) are removed. - Punctuation, repeated spaces and letter case are normalised.
- Name order does not matter:
Ivanov IvanandIvan Ivanovare treated the same. - Missing middle names and patronymics are tolerated.
Names in non-Latin scripts are rejected with 422 unsupported_script. Transliterate them before sending, or route them to manual review.
Date of birth
Section titled “Date of birth”Sanctions lists often publish only a year, a range (1970/1972) or several possible dates. The comparison is fuzzy:
| Outcome | Meaning | Effect |
|---|---|---|
exact |
Full date matches | Strong boost |
partial |
Year matches, or date inside a listed range | Moderate boost |
near |
Within one year, or day and month swapped | Small boost |
mismatch |
Clearly different | Penalty |
not_compared |
Missing on either side | No effect |
Choosing sources
Section titled “Choosing sources”By default, a screening searches the sources enabled for your project. Use GET /v1/sources to list available sources and their current versions. Pass sources to override the defaults for one request.
Retention
Section titled “Retention”By default, screenings are stored for your configured retention period and can be retrieved with GET /v1/screenings/{id}. In zero-retention mode, nothing is stored after the response is returned: retrieval returns 404, and no alert is created (alert_id is null).