> For the complete documentation index, see [llms.txt](https://docs.lumiid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lumiid.com/api-integration/aml-and-background-intelligence/aml-screening-api-or-sanctions-pep-and-watchlist-checks.md). # AML Screening API | Sanctions, PEP & Watchlist Checks ## AML Screening API for sanctions, PEP, and watchlist checks Use the LumiID AML Screening API to check individuals and businesses against sanctions lists, PEP registers, and watchlists. Support KYC and AML compliance for customers, vendors, and counterparties across Nigeria and Africa. Run AML due diligence during onboarding, before high-value transactions, or during scheduled re-screening. ### What this endpoint checks A single request screens against: * **Sanctions lists** — OFAC (US), UN Security Council Consolidated List, EU Consolidated List, UK HMT, and other national sanctions authorities * **PEP registers** — politically exposed persons and their known associates * **Adverse media / crime & conviction records** — where available per jurisdiction * **Local watchlists** — Nigeria, Kenya, Ghana, South Africa, and other supported jurisdictions ### Base URL ```http POST https://api.lumiid.com/v1/aml/screening/ ``` ### Authentication Requires a valid API key in the `Authorization` header. See [LumiID API Authentication](/api-integration/technical-references/lumiid-api-authentication-or-api-keys-sandbox-and-production.md) for credential and environment setup. ### Request | Field | Type | Required | Description | | ----------------- | -------------- | -------- | ---------------------------------------------------------------------- | | `entity_name` | string | Yes | Full name of the individual or business to screen | | `type` | string | Yes | `individual` or `business` | | `country` | array\[string] | No | Country/countries associated with the entity, improves match precision | | `gender` | string | No | `male` / `female` — narrows candidate matches for individuals | | `date_of_birth` | string | No | `YYYY-MM-DD` — improves match precision, reduces false positives | | `idempotency_key` | string | No | Prevents duplicate billing/re-screening on retry | #### Sample request ```json { "entity_name": "John Doe", "type": "individual", "country": ["Nigeria"], "gender": "male" } ``` ```bash curl -X POST https://api.lumiid.com/v1/aml/screening/ \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "entity_name": "John Doe", "type": "individual", "country": ["Nigeria"], "gender": "male" }' ``` ### Response ```json { "success": true, "code": "AML_SCREENING_COMPLETE", "message": "Screening completed", "summary": { "overall_risk": "HIT", "verification_type": "AML_SCREENING" }, "data": { "screening_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "entity": { "name": "Abubakar Shekau", "type": "individual", "country": ["Nigeria"] }, "overall_risk": "HIT", "review_required": true, "categories": [ { "category": "SANCTIONS", "hits_found": 38 }, { "category": "NIGERIA_WATCHLIST", "hits_found": 2 }, { "category": "PEP", "hits_found": 0 }, { "category": "ADVERSE_MEDIA", "hits_found": 0 } ], "matches": [ { "matched_name": "Abubakar Mohammed Shekau", "category": "SANCTIONS", "list_name": "UN Security Council Consolidated Sanctions List", "authority": "United Nations Security Council", "country": "Nigeria", "match_confidence": "HIGH", "aliases": ["Shekau", "Shehu", "Imam Darul Tauhid"], "source_url": "https://www.un.org/securitycouncil/sanctions/1267/aq_sanctions_list" }, { "matched_name": "Shehu Abubakar", "category": "NIGERIA_WATCHLIST", "list_name": "NAPTIP Sexual Offenders List", "authority": "National Agency for the Prohibition of Trafficking in Persons", "country": "Nigeria", "match_confidence": "MEDIUM", "aliases": [], "source_url": "https://nsod.naptip.gov.ng/result.php" } ], "lists_screened": 40 }, "meta": { "request_id": "req_9f8e7d6c5b4a", "timestamp": "2026-07-31T05:08:52Z", "api_version": "1.0" } } ``` #### Response fields | Field | Description | | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `summary.overall_risk` | `CLEAR` (no hits), `REVIEW` (low/ambiguous confidence matches, needs human review), or `HIT` (high-confidence match found) | | `data.categories` | Hit counts broken down by screening category | | `data.matches` | Individual matched records — deduplicated, one entry per distinct list | | `data.matches[].match_confidence` | `HIGH`, `MEDIUM`, or `LOW` — bucketed match strength | | `data.matches[].source_url` | Public source the match was found on, for your own compliance audit trail | | `data.lists_screened` | Total number of lists checked, for audit/reporting purposes | > **Note:** Standard responses omit raw scoring internals, matching-engine metadata, and provider identifiers. This keeps payloads consistent and audit-ready when list providers change. Enterprise compliance plans can request extended diagnostics for regulator submissions. ### Response codes | Code | Meaning | | ------------------------ | ------------------------------------------------------------------- | | `AML_SCREENING_COMPLETE` | Screening ran successfully (check `overall_risk` for outcome) | | `AML_ENTITY_NOT_FOUND` | Insufficient identifying information to run a screen | | `AML_SCREENING_TIMEOUT` | Upstream list provider timed out — no charge applied, safe to retry | | `AML_INVALID_REQUEST` | Missing or malformed required fields | ### FAQ **Does this cover PEP screening as well as sanctions?** Yes — a single request screens sanctions lists, PEP registers, and available watchlists together; category-level hit counts are broken out in the response. **Which countries' watchlists are supported?** Nigeria, Kenya, Ghana, South Africa, and other jurisdictions are supported alongside global lists from OFAC, the UN, EU, and UK HMT. Coverage expands over time. **Is this suitable for ongoing monitoring?** Use scheduled re-screening for existing customers. Avoid polling this endpoint manually. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.lumiid.com/api-integration/aml-and-background-intelligence/aml-screening-api-or-sanctions-pep-and-watchlist-checks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.