Creates one or more background check requests. Accepts a batch, so a single call can onboard several candidates at once.
Side effect: each candidate is emailed an invitation linking to the form they must complete. Creating a request is therefore not silent — do not use it to stage records you are not ready to contact people about.
Authorization
ApiKeyAuth In: header
TypeScript Definitions
Use the request body type in TypeScript.
Serializer for creating candidate requests.
Response Body
application/json
curl -X POST "https://example.com/api/v1/api/bgc/requests/candidates/" \ -H "Content-Type: application/json" \ -d '{ "package": "42c45dbe-c757-4802-9daf-2ba30b05e392", "callback_url": "http://example.com", "service_type": "string", "candidates": [ { "candidate_name": "string", "candidate_email": "user@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_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 ChannelList 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.
Get a candidate request GET
Returns a single candidate request, including its current status, the package and check types attached to it, and the candidate's submitted details where the form has been completed.