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.
Authorization
ApiKeyAuth In: header
Query Parameters
Restrict to one side: individual for identity channels, business for registration channels. Omit for both.
Response Body
application/json
curl -X GET "https://example.com/api/v1/verification/aml-screening/available-channels?category=individual"{ "data": {}, "status": true, "response_code": "00", "message": "string", "billing_info": { "was_charged": true, "amount": "string", "currency": "string" }}response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.
Join Slack ChannelVerify 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.
Upload Excel file for bulk AML screening POST
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