Endpoint
Request Headers
Query Parameters
string
required
Your internal user ID. The user must have an existing identity record on FraudEG (created via
POST /v1/identity/verify). FraudEG uses the stored identity data to perform the screening.string
Comma-separated list of watchlist databases to screen against. Omit this parameter to screen against all available lists by default. Accepted values:
ofac— OFAC Specially Designated Nationals (SDN) listeu_sanctions— EU Consolidated Sanctions Listun_sanctions— UN Security Council Consolidated Listpep— Politically Exposed Persons databaseadverse_media— Adverse media and negative news sources
?user_id=usr_8f3kd92&lists=ofac,pepstring
Screen by name directly, without requiring the user to have an existing identity record in FraudEG. Use this for one-off lookups during onboarding before you call
/v1/identity/verify.string
ISO 8601 date (
YYYY-MM-DD). Provide this alongside name to narrow matches and reduce false positives when multiple entities share the same name.Response Fields
string
Your internal user ID, echoed back from the request.
string
Overall screening result. One of:
clear— No matches found across all screened lists.match— A high-confidence match was found. Do not proceed until reviewed.possible_match— A potential match was found with lower confidence. Manual review is required.
array
List of match objects. This array is empty when
status is clear.string
ISO 8601 timestamp of when the screening was performed (e.g.,
"2024-11-15T13:20:00Z").Code Example
cURL
Example Response — Clear
Example Response — Possible Match
A
possible_match status means FraudEG found an entity with a similar name or profile, but the confidence score is below the threshold for a confirmed match. You must complete a manual review before onboarding or transacting with this user. Record the outcome of your review using POST /v1/decisions to maintain a complete compliance audit trail.