Prembly
GuidesAPI Reference
Background ChecksReportsGet a candidate report GET
GET
/api/v1/api/bgc/requests/candidates/{reference}/report/

Returns the completed background check report for a candidate.

A report exists only once the checks have finished. Poll the request itself, or wait for the status webhook, before calling this.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

reference*string

Candidate request reference, returned as reference when the request was created.

Formatuuid

Response Body

application/json

curl -X GET "https://example.com/api/v1/api/bgc/requests/candidates/497f6eca-6276-4993-bfeb-53cbbbba6f08/report/"
{  "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 Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Reset report customization POST

Discards your saved branding and layout and returns the reports to Prembly's defaults. Reports already produced are unchanged.

Reinitiate a candidate request POST

Reissues the candidate invitation for a request that expired or was never completed. **Side effect:** sends the candidate a fresh invitation email.