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.
Authorization
ApiKeyAuth In: header
Response Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/countries/"{ "data": {}, "status": true, "message": "Request successful.", "errors": {}, "meta": { "timestamp": "2019-08-24T14:15:22Z", "version": "v1", "request_id": "string" }, "pagination": { "page": 0, "page_size": 0, "total_pages": 0, "total_items": 0 }}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 ChannelGet check statistics GET
Aggregate counts for your organisation's background checks: totals by status, the check types and countries you use most, and package usage. Scoped to the organisation that owns the API key.
Perform AML screening (Sanction and PEP check) POST
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