Returns the background check packages available to your organisation: the custom packages you have created, and — when system=yes — the predefined system packages.
Authorization
ApiKeyAuth In: header
Query Parameters
Include unsaved packages (yes/no).
Return packages created on this date (YYYY-MM-DD).
dateMatch packages by name.
Return system packages (yes) or custom packages (no).
Response Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/packages/?system=yes"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "country": "string", "country_code": "string", "check_types": null, "is_active": true, "is_public": true, "created_by": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "first_name": "string", "last_name": "string", "email": "user@example.com", "last_login": "2019-08-24T14:15:22Z" }, "allow_candidate_access_report": true, "allow_candidate_payment": 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 a country's check types GET
Returns the check types available in one country. `country_code` is required; omitting it returns `400` rather than every country's checks.
Create a package POST
Creates a custom package bundling the check types you select. The package then becomes selectable when creating candidate requests. Package names must be unique within your organisation.