About this endpoint
What it does
Screens a person's name against OFAC, UN, and EU sanctions/AML watchlists using fuzzy, phonetic, and token matching, and returns candidate matches with confidence scores, matched programs, and a risk recommendation.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | String | Yes | Name to screen. |
| dob | String | No | Date of birth (YYYY-MM-DD) — reinforces a match. |
| country | String | No | Country filter. |
| limit | Integer | No | Maximum number of results. Default: 10. |
Response
Returns a JSON object with the request status and a SANCTIONS object holding the match verdict, candidate matches, the watchlists screened, and a risk score with a recommendation.
| Attribute | Type | Description |
|---|---|---|
| success | Boolean | Whether the request succeeded. |
| code | Integer | Numeric response code. |
| SANCTIONS | Object | Screening result. |
| SANCTIONS.query | Object | The name/dob/country submitted. |
| SANCTIONS.is_match | Boolean | Whether any candidate match was found. |
| SANCTIONS.match_status | String | no_match, possible_match, or match. |
| SANCTIONS.confidence | Number | Confidence of the top match (0–1). |
| SANCTIONS.match_count | Integer | Number of candidate matches returned. |
| SANCTIONS.matches | Array | Candidate matches — name, list, type, programs, score, match type. |
| SANCTIONS.lists_screened | Array | Watchlists checked (UN, OFAC-SDN, EU). |
| SANCTIONS.entries_indexed | Integer | Total watchlist entries searched. |
| SANCTIONS.risk_score | Number | Overall risk score (0–1). |
| SANCTIONS.risk_level | String | low, medium, or high. |
| SANCTIONS.recommendation | String | accept, review, or reject. |
| SANCTIONS.summary | String | Plain-language explanation of the result. |
| SANCTIONS.reasons | Array | Codes/messages explaining the risk drivers. |


