Prembly
GuidesAPI Reference
AML and PEP ScreeningUpload Excel file for bulk AML screening POST
POST
/api/v1/verification/aml-screening/bulk/

Upload an Excel file containing multiple records for AML screening. The system will process each record asynchronously and generate a result file with screening outcomes.

Excel Format:

  • Required columns: first_name, last_name
  • Optional columns: other_name, gender, number, email, dob (YYYY-MM-DD)
  • Maximum 10,000 records per file
  • Supported formats: .xlsx, .xls
  • Maximum file size: 10MB

Check Types:

  • Applied to all records in the file
  • 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 for all records (true/false, default: false)
  • When enabled, includes adverse media coverage in screening results

Pricing:

  • NGN 500 per record
  • USD 0.50 per record
  • Charges are debited per successful processing

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for bulk AML screening upload.

Response Body

application/json

curl -X POST "https://example.com/api/v1/verification/aml-screening/bulk/" \  -H "Content-Type: application/json" \  -d '{    "file": "(binary Excel file)",    "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 screening channels GET

Lists the verification channels that can feed a screen, with the payload each one expects. Call this before **Verify an ID then screen** or **Verify a business then screen** rather than guessing a `channel_code`: the response gives the exact `payload` shape to nest under `kyc` or `kyb`, so the two calls fit together without trial and error. Not billed.

Screen against PEP databases POST

Screens an individual against Politically Exposed Persons databases only. Identical to `/aml-screening` with `check_type: ["pep"]`. Sanctions matches are not returned — use `/aml-screening` when you need both in one call and one charge. Billed per screening and debited from the organisation wallet.