Returns the check types available in one country. country_code is required; omitting it returns 400 rather than every country's checks.
Authorization
ApiKeyAuth In: header
Query Parameters
Three-letter country code (ISO 3166-1 alpha-3).
Response Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/country/check-types/?country_code=NGN"{ "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_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 all check types GET
Returns every check type, optionally narrowed by country. **Prices are yours, not list prices.** Where your organisation has negotiated an override it replaces the country default in the response. Currency follows `country_code` when you pass one, and otherwise your wallet's currency — so the same check can come back priced differently depending on how you ask.
List packages GET
Returns the background check packages available to your organisation: the custom packages you have created, and — when `system=yes` — the predefined system packages.