Skip to content
Console(opens in a new tab)

Screen a person

Screen one individual, such as a beneficial owner or an applicant, against sanctions, debarment and PEP lists, with no business to match.

POSThttps://api.enigma.com/v2/kyb/?attrs=watchlist

Check one individual against the sanctions, debarment and PEP lists, with no business to match. Like every use case, it is one POST /v2/kyb/ request. A person sent with a business request is used for matching, and screening of that person is not guaranteed. To screen each beneficial owner or applicant, send a separate person-only request, one person per request, and log each response_id with the business’s.

This request screens Jane Smith, with her date of birth:

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?attrs=watchlist" \
--header "x-api-key: $ENIGMA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"person": {
"first_name": "Jane",
"last_name": "Smith",
"date_of_birth": "1980-01-15"
}
}'
x-api-keyheaderRequired

Your API key. Send it from your server only. See Authentication.

attrsqueryRequired

watchlist, exactly. You can send products=watchlist instead. Any other value, or neither parameter, returns 400. See Query parameters.

packagequery

identify or verify. Optional, and changes only which standard tasks come back.

person.first_namebody, string

The person’s first name. Send it with last_name.

person.last_namebody, string

The person’s last name.

person.date_of_birthbody, string

YYYY-MM-DD. Add it when you have it; a listed person’s date of birth can then count toward a match.

The body carries only the person: person, or persons with one item. The full rules are in Screen a person without a business. All body fields are in Request body, and the rules in Validation.

dataobject

registered_entities and brands, both empty arrays. See The data object.

risk_summary.tasks[]array

The watchlist task, after the package’s standard tasks. Find it by task_name and branch on its result. See The watchlist task.

Show the 3 result values
watchlist_no_hitssuccess
Screening completed and found no hits. watchlists is [].
watchlist_hitsfailure
One or more hits are listed in watchlists. The list can be partial, when screening ran out of time after finding some hits; see When screening does not complete.
not_completedfailure
Screening did not complete and found no hits. This is not a clean screen: retry the request. watchlists is ["Screen API error"] if the screening service was unavailable, or [] if screening timed out.
watchlistsarray

One object per hit. See Watchlist hits.

With attrs=watchlist, the package’s standard tasks come back too, each with its no-match result, since there is no business to check. Read only the watchlist task, and find it by task_name. With products=watchlist, it is the only task.

  • Business fields. Any business field, such as name, address, website or tin, makes it a business request, and a business name is then required. See Screen a person without a business.
  • Account enablement. watchlist is an add-on; see Account enablement.
  • A hit is not a confirmed match. A hit means a listed entity resembles the person you sent. See Interpret a hit.
  • Watchlist screening: what is screened, the lists, PEP coverage and the hit object.
  • Screen a business: the same lists, run against a business and the people on its registrations.
  • Onboard a business: verification and screening for the business, alongside these person screens.