A package is a preselected collection of checks. This can be used instead of specifying each check type for an order. Packages are agreed and created by Verifile in advance and can’t be created via the API.

Packages currently can only be for candidate entry orders. In the candidate entry order the package ID is passed in the body when Posting the order.

The response will contain an array of objects which have an Id, name and the checks that the package contains. If no packages are available then an empty list will be returned.

GET /api/v1/metadata/packages

If an ID of a package is known, then passing the ID as a parameter will show just details of that package.

GET /api/v1/metadata/packages/{id}