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.
Authorization
ApiKeyAuth In: header
Path Parameters
Candidate request reference, returned as reference when the request was created.
uuidResponse Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/requests/candidates/497f6eca-6276-4993-bfeb-53cbbbba6f08/timeline/"{ "data": [ { "id": 0, "event_type": "package_created", "event_type_display": "string", "title": "string", "description": "string", "visibility": "public", "visibility_display": "string", "actor_type": "string", "actor_name": "string", "actor_email": "user@example.com", "metadata": null, "is_milestone": true, "is_error": true, "created_at": "2019-08-24T14:15:22Z", "time_ago": "string" } ], "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 ChannelStart a background check POST
Sends a candidate's submitted details to the verification provider and begins the checks. **Only valid while the request is `submitted`** — that is, after the candidate has completed their form. Calling it in any other state returns `409` with the current status, so use that status rather than retrying. Progress is reported back through the status webhook; this call returns once the work has been accepted, not once it is finished.
Get 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.