- Docs
- API reference
- Endpoints and schemas
- KYB API
- Use cases
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.
https://api.enigma.com/v2/kyb/?attrs=watchlistCheck 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.
Example
Section titled “Example”This request screens Jane Smith, with her date of birth:
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" } }'This example response is trimmed to the watchlist task. dob is null
because only the name drove the match.
{ "risk_summary": { "tasks": [ { "task_name": "watchlist", "status": "failure", "result": "watchlist_hits", "reason": "1 hit(s) were identified on the consolidated sanctions list (including OFAC)" } ] }, "response_id": "2a1b3c4d-5e6f-7890-abcd-ef1234567890", "data": { "registered_entities": [], "brands": [] }, "watchlists": [ { "id": "ofac/sdn/58210", "match_confidence": 0.87, "watchlist_entity": { "watchlist_name": "SDN", "entity_type": "person", "full_name": "JANE SMITHE", "organization_name": null, "dob": null, "full_address": null }, "matched_fields": { "person_name": "JANE SMITHE" } } ]}Parameters
Section titled “Parameters”x-api-keyRequiredYour API key. Send it from your server only. See Authentication.
attrsRequiredwatchlist, exactly. You can sendproducts=watchlistinstead. Any other value, or neither parameter, returns400. See Query parameters.packageidentifyorverify. Optional, and changes only which standard tasks come back.person.first_nameThe person’s first name. Send it with
last_name.person.last_nameThe person’s last name.
person.date_of_birthYYYY-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.
Response
Section titled “Response”dataregistered_entitiesandbrands, both empty arrays. See Thedataobject.risk_summary.tasks[]The
watchlisttask, after the package’s standard tasks. Find it bytask_nameand branch on itsresult. See Thewatchlisttask.Show the 3 result values
watchlist_no_hitssuccess- Screening completed and found no hits.
watchlistsis[]. 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.
watchlistsis["Screen API error"]if the screening service was unavailable, or[]if screening timed out.
watchlistsOne 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.
Before you rely on it
Section titled “Before you rely on it”- Business fields. Any business field, such as
name,address,websiteortin, makes it a business request, and a business name is then required. See Screen a person without a business. - Account enablement.
watchlistis 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.
Related
Section titled “Related”- 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.