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.
Authorization
ApiKeyAuth In: header
Response Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/statistics/"{ "data": { "total_requests": 0, "completed_requests": 0, "pending_requests": 0, "completion_rate": 0.1, "total_packages": 0, "status_distribution": [ { "status": "string", "count": 0, "percentage": 0.1 } ], "check_types_distribution": [ { "check_type_id": "string", "check_type_name": "string", "count": 0 } ], "countries_distribution": [ { "country": "string", "country_code": "string", "count": 0 } ], "package_statistics": { "total_packages": 0, "active_packages": 0, "avg_checks_per_package": 0.1 } }, "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 a request timeline GET
Returns the full event history for a candidate request — every status change, provider update and document received, oldest first. Use this to show progress. For the summarised view, fetch the milestones.
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.