All Packages

📘

GET

https://api.prembly.com/background-check/api/v1/package

REQUEST HEADER

KeyValueDescription
x-api-keyAPI KeyYour live secret API key

RESPONSE


    "status": true,
    "status_code": "00",
    "detail": [
        {
            "id": "d383ea52-7edf-4c2a-af5a-24a413815df0",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "International Passport",
            "purpose": "Intl Pass",
            "country": "NG",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 1,
            "checks": [
                "Passport Ng"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-15T10:24:12.683Z"
        },
        {
            "id": "0e2af8be-c3f4-40dd-b950-50c40fba7da5",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "ghjkl",
            "purpose": "dfghjk",
            "country": "NG",
            "check_type": [
                "534ce573-105d-40da-a360-f8ca9d483705"
            ],
            "no_of_checks": 1,
            "checks": [
                "Degree"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-15T09:52:04.215Z"
        },
        {
            "id": "70d70749-5fd6-4459-b1a8-ae1c3ced7d11",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "kenya crim",
            "purpose": "kenya crim",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-13T23:20:00.704Z"
        },
        {
            "id": "26f19973-1deb-4b3d-acec-8b5330f179a1",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "KENYA CHC",
            "purpose": "KENYA CHC",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-13T10:00:07.376Z"
        },
        {
            "id": "94e21d59-743c-46b3-b80a-04b7bbf6b8b7",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "GHANA CHC",
            "purpose": "GHANA CHC",
            "country": "GH",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-13T10:00:07.376Z"
        },
        {
            "id": "efd595fa-f889-4ed8-bf17-58562458a637",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "kenya 2",
            "purpose": "kenya crim 2",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-13T09:02:56.841Z"
        },
        {
            "id": "570dafeb-149a-460b-b395-4b0e5ab3e8e3",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Kenya",
            "purpose": "Crim Kenya",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-12T15:28:37.628Z"
        },
        {
            "id": "d1d833f0-23b3-4e7c-85fb-b2e6772a9fc1",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Ghana",
            "purpose": "Crim Ghana",
            "country": "GH",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-12T15:28:37.628Z"
        },
        {
            "id": "4c4e2bd9-9784-471d-9dd1-cec6f949915e",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Crim",
            "purpose": "Crim K",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-12T15:03:38.624Z"
        },
        {
            "id": "9a45a9ad-0803-477c-85b9-a614bedc28a7",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Gh",
            "purpose": "Gh 1",
            "country": "GH",
            "check_type": [
                "f5bb970e-67e7-4408-b7e2-cea7ab1bec10",
                "534ce573-105d-40da-a360-f8ca9d483705"
            ],
            "no_of_checks": 2,
            "checks": [
                "Driving License Gh",
                "Degree"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-12T08:54:52.379Z"
        },
        {
            "id": "fad69aa6-0788-487b-a12c-8369ea85e91c",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "gh4",
            "purpose": "gh4",
            "country": "GH",
            "check_type": [
                "4efa701c-fe2f-4345-99ad-ddabc251294b"
            ],
            "no_of_checks": 1,
            "checks": [
                "Credit Check Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T23:54:10.941Z"
        },
        {
            "id": "fb33a910-1d51-460d-9ec3-ad634baaac37",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "gh 5",
            "purpose": "gh5",
            "country": "GH",
            "check_type": [
                "89a865e5-4460-4023-afa2-9638b24c0241"
            ],
            "no_of_checks": 2,
            "checks": [
                "Character Reference",
                "Employment References"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T23:54:10.941Z"
        },
        {
            "id": "9e1613c2-953f-442f-88f0-514c7d06c480",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "gh 2",
            "purpose": "gh 2",
            "country": "GH",
            "check_type": [
                "f5bb970e-67e7-4408-b7e2-cea7ab1bec10"
            ],
            "no_of_checks": 1,
            "checks": [
                "Driving License Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T23:37:28.719Z"
        },
        {
            "id": "1fd6cf84-87ab-4640-9f32-2919e61dc152",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Gh1",
            "purpose": "Gh1",
            "country": "GH",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T23:06:45.883Z"
        },
        {
            "id": "30e6239c-91c1-471b-9b37-1af19a673aa9",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "gh3",
            "purpose": "gh3",
            "country": "GH",
            "check_type": [
                "f5bb970e-67e7-4408-b7e2-cea7ab1bec10"
            ],
            "no_of_checks": 1,
            "checks": [
                "Motor Vehicle Ownership Records Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T23:06:45.883Z"
        },
        {
            "id": "cc95bcac-66ac-4386-a7a5-7d443572c788",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "nmk, nn",
            "purpose": "nkl.m ",
            "country": "GH",
            "check_type": [
                "f5bb970e-67e7-4408-b7e2-cea7ab1bec10",
                "4efa701c-fe2f-4345-99ad-ddabc251294b",
                "89a865e5-4460-4023-afa2-9638b24c0241",
                "0e9a077e-7181-460d-8c1e-4fc0d0fc7eac",
                "534ce573-105d-40da-a360-f8ca9d483705",
                "875243bf-e096-4aaa-a79b-cdc98cb464f4",
                "8a430102-bf7b-48d9-9e54-5dc912a2d94d"
            ],
            "no_of_checks": 14,
            "checks": [
                "Driving License Gh",
                "Motor Vehicle Ownership Records Gh",
                "Credit Check Gh",
                "Character Reference",
                "Employment References",
                "Educational References",
                "Professional References",
                "Address Verification",
                "Masters",
                "Certificate",
                "Degree",
                "Criminal History Gh",
                "Past Employer Gh",
                "Current Employer Gh"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T22:19:27.481Z"
        },
        {
            "id": "66ff94ff-464d-41e8-b5a4-d417bcd155e1",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "gh",
            "purpose": "emp",
            "country": "GH",
            "check_type": [
                "0e9a077e-7181-460d-8c1e-4fc0d0fc7eac",
                "f5bb970e-67e7-4408-b7e2-cea7ab1bec10",
                "4efa701c-fe2f-4345-99ad-ddabc251294b",
                "875243bf-e096-4aaa-a79b-cdc98cb464f4",
                "89a865e5-4460-4023-afa2-9638b24c0241",
                "534ce573-105d-40da-a360-f8ca9d483705"
            ],
            "no_of_checks": 11,
            "checks": [
                "Address Verification",
                "Driving License Gh",
                "Motor Vehicle Ownership Records Gh",
                "Credit Check Gh",
                "Criminal History Gh",
                "Character Reference",
                "Employment References",
                "Educational References",
                "Professional References",
                "Masters",
                "Degree"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T22:03:09.078Z"
        },
        {
            "id": "ad0db576-860c-4bd6-9eb8-02b6ac4bd760",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Education TG",
            "purpose": "New Hire GH",
            "country": "GH",
            "check_type": [
                "534ce573-105d-40da-a360-f8ca9d483705"
            ],
            "no_of_checks": 3,
            "checks": [
                "Degree",
                "Masters",
                "Certificate"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T13:46:56.278Z"
        },
        {
            "id": "59ae5014-47f4-4e1b-9d4a-e6859b8b8826",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Ghana Check",
            "purpose": "Employee Onboarding",
            "country": "GH",
            "check_type": [
                "534ce573-105d-40da-a360-f8ca9d483705",
                "8a430102-bf7b-48d9-9e54-5dc912a2d94d",
                "89a865e5-4460-4023-afa2-9638b24c0241",
                "0e9a077e-7181-460d-8c1e-4fc0d0fc7eac"
            ],
            "no_of_checks": 10,
            "checks": [
                "Masters",
                "Degree",
                "Certificate",
                "Past Employer",
                "Current Employer",
                "Character Reference",
                "Employment References",
                "Educational References",
                "Professional References",
                "Address Verification"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-11T13:02:58.138Z"
        },
        {
            "id": "f9d85c4e-d5c3-429b-8bb5-faad648af63d",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "employment",
            "purpose": "employment 3",
            "country": "NG",
            "check_type": [
                "8a430102-bf7b-48d9-9e54-5dc912a2d94d"
            ],
            "no_of_checks": 2,
            "checks": [
                "Past Employer",
                "Current Employer"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-08T22:28:23.072Z"
        },
        {
            "id": "324c26d6-1263-4c39-bf46-f72e37a20be4",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Identity TD",
            "purpose": "New Prem Hire",
            "country": "NG",
            "check_type": [
                "0e7b4a88-8566-4995-a9b7-7f9060c25a48"
            ],
            "no_of_checks": 1,
            "checks": [
                "Professional Affiliate Membership Verification"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-06T13:23:40.567Z"
        },
        {
            "id": "f8906a00-676c-426e-869a-497e3f9c08eb",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Double Check",
            "purpose": "Identity & Criminal Check for New Hire",
            "country": "KE",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5",
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 2,
            "checks": [
                "National Id",
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-06T09:23:08.347Z"
        },
        {
            "id": "96ae6d9d-7010-4454-9222-f8d5a14d389a",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Education",
            "purpose": "New Employee Hire",
            "country": "NG",
            "check_type": [
                "534ce573-105d-40da-a360-f8ca9d483705"
            ],
            "no_of_checks": 2,
            "checks": [
                "Masters",
                "Degree"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-05T09:36:10.702Z"
        },
        {
            "id": "0a4199cb-cbb5-495b-af19-ae4ff496a28b",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Criminal Check",
            "purpose": "Bolt Drivers Requirement",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-03-05T09:36:10.702Z"
        },
        {
            "id": "3bda34c0-de14-4921-9e09-8d6d056a4199",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "ID Pack",
            "purpose": "New",
            "country": "KE",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 1,
            "checks": [
                "National Id"
            ],
            "created_by": "API",
            "status": true,
            "created_at": "2024-03-01T13:33:44.390Z"
        },
        {
            "id": "9a52c00f-76aa-4ebf-b4ae-918ac3ec7388",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Employment 2",
            "purpose": "New Hire Check",
            "country": "NG",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 1,
            "checks": [
                "National Id"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-29T14:19:16.058Z"
        },
        {
            "id": "77b286d9-4da7-4613-aadc-bd45eab375c6",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Employment 1",
            "purpose": "New Hire Background Verification",
            "country": "NG",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 1,
            "checks": [
                "National Id"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-29T13:12:06.046Z"
        },
        {
            "id": "88f2379c-2946-41e2-ae0c-a0ac2aaa1aaf",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Bolt",
            "purpose": "Bolt Drivers",
            "country": "KE",
            "check_type": [
                "875243bf-e096-4aaa-a79b-cdc98cb464f4"
            ],
            "no_of_checks": 1,
            "checks": [
                "Criminal History"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-26T09:37:43.437Z"
        },
        {
            "id": "a863442d-3dbd-46eb-b549-94f9391c1f9c",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Identity T1",
            "purpose": "Identification T1",
            "country": "NG",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 0,
            "checks": [],
            "created_by": "API",
            "status": true,
            "created_at": "2024-02-23T09:43:23.044Z"
        },
        {
            "id": "c312b5b5-fe7a-4c94-88aa-bc0e56b6e4b6",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Uber",
            "purpose": "Driver Onboarding",
            "country": "NG",
            "check_type": [
                "95af7624-d3fe-4891-acf2-2e28407b831d"
            ],
            "no_of_checks": 0,
            "checks": [],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-21T10:11:43.418Z"
        },
        {
            "id": "88b323d1-e7c1-4892-a5ac-751a9b9ab845",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Employment",
            "purpose": "Verification",
            "country": "NG",
            "check_type": [
                "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5"
            ],
            "no_of_checks": 1,
            "checks": [
                "Alien Id"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-19T09:57:22.940Z"
        },
        {
            "id": "859a7666-58fc-4e40-9302-929f56ed3b9a",
            "organisation": "cf9082f1-9544-487b-9420-19fe79f2c509",
            "name": "Academics",
            "purpose": "Academics",
            "country": "NG",
            "check_type": [
                "89a865e5-4460-4023-afa2-9638b24c0241"
            ],
            "no_of_checks": 1,
            "checks": [
                "Employment References"
            ],
            "created_by": "Zeenat Gbadamosi",
            "status": true,
            "created_at": "2024-02-19T01:15:06.289Z"
        }
    ]
}

RESPONSE DESCRIPTION

ResponseDescription
statusWhen status is true, the API call was successful
status_codeStatus of the response
detailAn array showing the check ID, organisation, check name, purpose, country,check type, number of checks, checks, created by, status and created at.
idA unique identifier for a particular check name
organisationA unique identifier for a registered business
nameName of Check
purposeA description of what you can remember the package by
countryCountry where the package is created
check_typeA type of check
no_of_checksNumber of checks selected
checkA sub-service available under a check type
created_byThe name of the person who created the package
created_atThe date the package was created