Get All Available Checks

📘

GET

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

REQUEST HEADER

KeyValueDescription
x-api-keyAPI keyYour live secret API key

RESPONSE

{
    "status": true,
    "status_code": "00",
    "detail": [
        {
            "id": "bb4aa6d8-72bc-41d5-b61d-d17ede90572a",
            "name": "Know Your Business (KYB)",
            "created_at": "2024-03-11T00:57:52.742Z"
        },
        {
            "id": "902b8cc1-d02f-4cbb-8e31-d1fb1e3a9ad5",
            "name": "Litigation",
            "created_at": "2024-03-11T00:09:39.819Z"
        },
        {
            "id": "f5bb970e-67e7-4408-b7e2-cea7ab1bec10",
            "name": "Driving",
            "created_at": "2024-02-20T04:31:02.350Z"
        },
        {
            "id": "1c646977-434d-4be7-8d9c-cd7fb3696965",
            "name": "Documents",
            "created_at": "2024-02-14T09:06:33.628Z"
        },
        {
            "id": "4efa701c-fe2f-4345-99ad-ddabc251294b",
            "name": "Financial",
            "created_at": "2024-02-09T14:18:12.468Z"
        },
        {
            "id": "0e7b4a88-8566-4995-a9b7-7f9060c25a48",
            "name": "Membership",
            "created_at": "2023-12-02T10:25:00.356Z"
        },
        {
            "id": "89a865e5-4460-4023-afa2-9638b24c0241",
            "name": "References",
            "created_at": "2023-12-02T08:53:29.454Z"
        },
        {
            "id": "0e9a077e-7181-460d-8c1e-4fc0d0fc7eac",
            "name": "Address Verification",
            "created_at": "2023-11-16T08:50:05.820Z"
        },
        {
            "id": "534ce573-105d-40da-a360-f8ca9d483705",
            "name": "Education Check",
            "created_at": "2023-11-16T08:50:05.820Z"
        },
        {
            "id": "875243bf-e096-4aaa-a79b-cdc98cb464f4",
            "name": "Criminal Check",
            "created_at": "2023-11-16T08:50:05.820Z"
        },
        {
            "id": "8a430102-bf7b-48d9-9e54-5dc912a2d94d",
            "name": "Employment History",
            "created_at": "2023-11-16T08:50:05.820Z"
        },
        {
            "id": "aa55bc3e-1a64-427b-b3cd-e0f2df315ad5",
            "name": "Identity",
            "created_at": "2023-11-16T08:50:05.820Z"
        }

RESPONSE DESCRIPTION


ResponseDescription
statusWhen status is true, the API call was successful
status_codeStatus of the response
detailAn array showing the check name, check id and created at
idA unique identifier for a particular check name
nameName of Check
created_atDate & Time the package was created