API Status

The API Status Endpoint provides a real-time status overview of various services integrated into the platform. This endpoint retrieves the status of each service, indicating whether the service is currently active or inactive, based on recent transaction data.

KEY DATA POINTS

ServiceIdentifier: The unique name of the service (e.g., "NIN", "LIVELINESSCHECK").
isActive: A boolean indicating whether the service is currently active.

📘

GET

{{URL}}/dikript/service/api/v1/status

Header

Key	Description
x-api-key	Your Public Key

Response

jsc

{
    "status": true,
    "message": "Successful",
    "code": "200",
    "apiVersion": "v1",
    "transactionRef": "N202410230344264927",
    "data": [
        {
            "serviceIdentifier": "CONSOLIDATEDBUREAU",
            "isActive": true
        },
        {
            "serviceIdentifier": "LIVELINESSCHECK",
            "isActive": true
        },
        {
            "serviceIdentifier": "CRC",
            "isActive": false
        },
        {
            "serviceIdentifier": "ANALYSEPDF",
            "isActive": false
        },
        {
            "serviceIdentifier": "CACADVANCED",
            "isActive": false
        },
        {
            "serviceIdentifier": "CREDITADVANCED",
            "isActive": false
        },
        {
            "serviceIdentifier": "CACBASIC",
            "isActive": true
        },
        {
            "serviceIdentifier": "PHONENUMBER",
            "isActive": true
        },
        {
            "serviceIdentifier": "BVNNIN",
            "isActive": true
        },
        {
            "serviceIdentifier": "NIN",
            "isActive": true
        },
        {
            "serviceIdentifier": "TIN",
            "isActive": false
        },
        {
            "serviceIdentifier": "ANALYSETRANSACTION",
            "isActive": true
        },
        {
            "serviceIdentifier": "FICO",
            "isActive": false
        },
        {
            "serviceIdentifier": "PHONENUMBERBASIC",
            "isActive": true
        },
        {
            "serviceIdentifier": "ANALYSE",
            "isActive": true
        },
        {
            "serviceIdentifier": "BVN",
            "isActive": false
        },
        {
            "serviceIdentifier": "AFFORD",
            "isActive": true
        },
        {
            "serviceIdentifier": "FRSC",
            "isActive": false
        },
        {
            "serviceIdentifier": "IDENTITYCOMPARISON",
            "isActive": true
        },
        {
            "serviceIdentifier": "PHONENUMBERADVANCED",
            "isActive": true
        },
        {
            "serviceIdentifier": "FIRSTCENTRAL",
            "isActive": false
        },
        {
            "serviceIdentifier": "CREDITREGISTRY",
            "isActive": true
        },
        {
            "serviceIdentifier": "OCR",
            "isActive": false
        },
        {
            "serviceIdentifier": "FACECOMPARISON",
            "isActive": true
        }
    ],
    "error": null
}

JSON

{
    "message": "Unsuccessful",
    "code": "400",
    "apiVersion": "v1",
    "transactionRef": "N202401101345487388",
    "data": "",
    "error": {
        "code": 400,
        "message": null
    }
}

js

{
    "status": true,
    "message": "nin not found",
    "code": "200",
    "apiVersion": "v1",
    "transactionRef": "N202401101323024787",
    "data": {
        "firstName": "",
        "birthDate": "",
        "employmentStatus": "",
        "gender": "",
        "middleName": "",
        "nin": "",
        "vNin": "",
        "email": "",
        "otherName": "",
        "profession": "",
        "birthCountry": "",
        "otherSpokenLang": "",
        "nokFirstName": "",
        "nokLastName": "",
        "nokMiddleName": "",
        "photo": "",
        "residenceAdressLine1": "",
        "residenceAdressLine2": "",
        "residenceLga": "",
        "residenceState": "",
        "selfOriginState": "",
        "selfOriginLga": "",
        "selfOriginPlace": "",
        "signature": "",
        "surname": "",
        "telephoneNo": "",
        "title": "",
        "trackingId": ""
    },
    "error": null
}