Returns the request's progress as a short list of milestones rather than every event — the view to drive a progress bar from.
Fetch the timeline when you need the detail behind a milestone.
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/milestones/"{ "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 ChannelCancel a candidate request POST
Cancels a request before a provider has picked it up. Allowed only while the status is `pending` or `pending_payment` and no `verification_id` has been assigned. Once a provider has started work the request can no longer be cancelled and this returns `409`. The candidate is never notified of a cancellation.
Start 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.