Prembly
GuidesAPI Reference
Background ChecksRequestsReinitiate a candidate request POST
POST
/api/v1/api/bgc/candidates/{reference}/reinitiate/

Reissues the candidate invitation for a request that expired or was never completed.

Side effect: sends the candidate a fresh invitation email.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

reference*string

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

Formatuuid

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for re-initiating candidate requests.

Response Body

application/json

curl -X POST "https://example.com/api/v1/api/bgc/candidates/497f6eca-6276-4993-bfeb-53cbbbba6f08/reinitiate/" \  -H "Content-Type: application/json" \  -d '{    "callback_url": "http://example.com"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "candidate_name": "string",    "candidate_email": "user@example.com",    "status": "pending",    "response_submitted": true,    "organisation": "string",    "package": "string",    "created_by": "string",    "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",    "verification_id": "string",    "service_type": "string",    "payment_reference": "string",    "payment_gateway": "string",    "payment_status": "string",    "additional_fields": null,    "candidate_submitted_data": null,    "notification_preferences": null,    "editing_history": null,    "current_editing_fields": "string",    "cancellation_reason": "string",    "cancelled_at": "2019-08-24T14:15:22Z",    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "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

Get a candidate report GET

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.

List candidate requests GET

Returns every background check request belonging to the organisation that owns the API key. Results are scoped to that organisation; there is no way to read another organisation's requests. Use `search` to match on candidate name or email.