Prembly
GuidesAPI Reference
AML and PEP ScreeningPerform AML screening (Sanction and PEP check) POST
POST
/api/v1/verification/aml-screening/

Screen individuals against global sanctions lists and Politically Exposed Persons (PEP) databases. Supports both sanction-only, PEP-only, or combined screening. Requires authentication and sufficient wallet balance. Charges are automatically debited from the organization's wallet.

Pricing:

  • NGN 500 per screening
  • USD 0.50 per screening

Check Types:

  • sanction: Screen against global sanctions lists
  • pep: Screen against Politically Exposed Persons database
  • Default: Both sanction and PEP screening

Media Search:

  • media_search: Enable media search in screening (true/false, default: false)
  • When enabled, includes adverse media coverage in screening results

Rule Evaluation:

  • rule_ids: Optional list of rule IDs to evaluate (array of UUIDs)
  • group_ids: Optional list of user rule group IDs to evaluate (array of UUIDs)
  • When group_ids is provided, all rules in the selected groups will be evaluated
  • When both rule_ids and group_ids are provided, rules from both sources are combined
  • When omitted, all active rules for the organization will be evaluated
  • Results are included in the response under data.rule_evaluation
  • Group usage statistics (usage_count, last_used_at) are automatically updated

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for AML Screening request. Handles both sanction and PEP screening.

Response Body

application/json

curl -X POST "https://example.com/api/v1/verification/aml-screening/" \  -H "Content-Type: application/json" \  -d '{    "first_name": "John",    "last_name": "Doe",    "other_name": "Michael",    "gender": "Male",    "number": 9082455489,    "email": "john.doe@example.com",    "dob": "1980-05-15",    "check_type": [      "sanction",      "pep"    ],    "media_search": true  }'
{  "data": {},  "status": true,  "response_code": "00",  "message": "string",  "billing_info": {    "was_charged": true,    "amount": "string",    "currency": "string"  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

List supported countries GET

Returns the countries background checks can be run in. Use the country code from here when asking which check types are available. The list changes rarely and is cached for 24 hours, so it is safe to call on startup rather than per request.

Verify an ID then screen POST

Verifies an identity document and screens the person using the details the verification returns, in one call. Use this instead of screening on names you were given: the screen runs against the name and date of birth held by the issuing authority, so a mistyped or deliberately altered name cannot slip past it. Supply the document under `kyc`, with the `channel_code` of the verification to run. Call **Available screening channels** to see which codes are supported — not every verification channel can feed a screen. **Two services, two charges.** The verification is billed as its own channel and the screening on top. A verification that fails stops the call before screening.