Returns one predefined package, including the check types it bundles.
Only active system packages are visible here; your own packages are served by the package endpoints.
Authorization
ApiKeyAuth In: header
Path Parameters
Package UUID.
uuidResponse Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/system-packages/497f6eca-6276-4993-bfeb-53cbbbba6f08/"{ "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 system packages GET
Returns the predefined packages Prembly maintains, usable without building your own. Check types are omitted from this list for brevity — fetch a single system package to see what it bundles.
Verify candidate payment GET
Confirms a candidate payment with the gateway and, once confirmed, submits the request to the verification provider. **This both verifies and advances the request** — it is the completion step of the candidate-paid flow, not a read-only status check. To read payment state without side effects, fetch the candidate request instead.