Response

{
    "status": true,
    "message": "Sucessful",
    "data": {
        "reference": "perilenda&12b05ed4373443d8ba85ec46b15862d5",
        "state": "pending",
        "business_registration_number": "BN809081021",
        "report_type": "full"
    }
}

Webhook Response

Below are sample responses expected based on the report_type in your request.

Basic Report Type

{
    "metadata": {
        "statusMessage": "SUCCESSFUL",
        "statusCode": "200",
        "timeStamp": "01/01/0001 00:00:00",
        "responseType": "INSIGHTS",
        "hmacMessage": "dd25c145d5d70caea61f2194ba28d54f62433e908afb339fcb8a4bed433989ec9798c2cc23280a8caba604b9aab98ae6f12887a691f44d695741a44d83cf1dd4"
    },
    "creditReport": {
        "reference": "perilenda\u0026fcbe874a19544c9ab0f8697c8240b48b",
        "state": "completed",
        "business_registration_number": "BN809081021",
        "report_type": "basic",
        "report": {
            "businessData": {
                "fax1": "",
                "fax2": "",
                "fax3": "",
                "fax4": "",
                "updatedOn": "",
                "vatNumber": "",
                "telephone1": "246990370",
                "telephone2": "233246990370",
                "telephone3": "",
                "telephone4": "",
                "webaddress": "",
                "referenceNo": "",
                "tradingName": "YEMAWUS ENTERPRISE",
                "businessName": "YEMAWUS ENTERPRISE",
                "businessType": "SOLE PROPRIETORSH",
                "commercialID": 296079,
                "noOfDirectors": "0",
                "industrySector": "80",
                "postalAddress1": "",
                "postalAddress2": "",
                "postalAddress3": "",
                "postalAddress4": "",
                "commercialEmail1": "[email protected]",
                "commercialEmail2": "",
                "commercialEmail3": "",
                "commercialEmail4": "",
                "commercialAddress1": "26 TDC INDUSTRIAL ZONE",
                "commercialAddress2": "",
                "commercialAddress3": "",
                "commercialAddress4": "",
                "dateOfCommencement": "13/10/2021",
                "dateOfIncorporation": "13/10/2021",
                "previousBusinessName": "",
                "taxIdentificationNumber": "",
                "businessRegistrationNumber": "BN809081021",
                "previousRegistrationNumber": ""
            },
            "addressHistory": null,
            "directorInformation": [],
            "creditAccountSummary": {
                "rating": "2",
                "lastJudgementDateEUR": "",
                "lastJudgementDateGBP": "",
                "lastJudgementDateGHS": null,
                "lastJudgementDateUSD": null,
                "totalActiveAccountsEUR": "0",
                "totalActiveAccountsGBP": "0",
                "totalActiveAccountsGHS": "1",
                "totalActiveAccountsUSD": null,
                "totalAmountInArrearEUR": null,
                "totalAmountInArrearGBP": null,
                "totalAmountInArrearGHS": null,
                "totalAmountInArrearUSD": null,
                "totalClosedAccountsEUR": "0",
                "totalClosedAccountsGBP": "0",
                "totalClosedAccountsGHS": "0",
                "totalClosedAccountsUSD": null,
                "totalAccountInArrearEUR": null,
                "totalAccountInArrearGBP": null,
                "totalAccountInArrearGHS": null,
                "totalAccountInArrearUSD": null,
                "totalJudgementAmountEUR": "0",
                "totalJudgementAmountGBP": "0",
                "totalJudgementAmountGHS": null,
                "totalJudgementAmountUSD": null,
                "totalOutstandingdebtEUR": "0.00",
                "totalOutstandingdebtGBP": "0.00",
                "totalOutstandingdebtGHS": null,
                "totalOutstandingdebtUSD": null,
                "totalNumberofAccountsEUR": "0",
                "totalNumberofAccountsGBP": "0",
                "totalNumberofAccountsGHS": "1",
                "totalNumberofAccountsUSD": "0",
                "lastBouncedChequesDateEUR": "",
                "lastBouncedChequesDateGBP": "",
                "lastBouncedChequesDateGHS": null,
                "lastBouncedChequesDateUSD": null,
                "totalDishonouredAmountEUR": "0.00",
                "totalDishonouredAmountGBP": "0.00",
                "totalDishonouredAmountGHS": null,
                "totalDishonouredAmountUSD": null,
                "totalMonthlyInstalmentEUR": "0.00",
                "totalMonthlyInstalmentGBP": "0.00",
                "totalMonthlyInstalmentGHS": null,
                "totalMonthlyInstalmentUSD": null,
                "totalNumberofJudgementEUR": "0",
                "totalNumberofJudgementGBP": "0",
                "totalNumberofJudgementGHS": null,
                "totalNumberofJudgementUSD": null,
                "totalNumberofDishonouredEUR": "0",
                "totalNumberofDishonouredGBP": "0",
                "totalNumberofDishonouredGHS": null,
                "totalNumberofDishonouredUSD": null,
                "totalaccountinGoodconditionEUR": null,
                "totalaccountinGoodconditionGBP": null,
                "totalaccountinGoodconditionGHS": null,
                "totalaccountinGoodconditionUSD": null
            },
            "creditAgreementSummary": null,
            "highestDelinquencyRating": {
                "highestDelinquencyRating": "6"
            },
            "accountMonthlyPaymentHistory": null
        }
    }
}

Full Report Type

{
    "metadata": {
        "statusMessage": "SUCCESSFUL",
        "statusCode": "200",
        "timeStamp": "01/01/0001 00:00:00",
        "responseType": "INSIGHTS",
        "hmacMessage": "a8c8e921b2ff2e8d28231071c46fd6c0af7817ab302cc7ded349f88b931c1f68d9d37c1885f485808bb9064e9d2d44570d46ca66cd8b595c6ca40934b963c23e"
    },
    "creditReport": {
        "reference": "perilenda\u002612b05ed4373443d8ba85ec46b15862d5",
        "state": "completed",
        "business_registration_number": "BN809081021",
        "report_type": "full",
        "report": {
            "businessData": {
                "fax1": "",
                "fax2": "",
                "fax3": "",
                "fax4": "",
                "updatedOn": "",
                "vatNumber": "",
                "telephone1": "246990370",
                "telephone2": "233246990370",
                "telephone3": "",
                "telephone4": "",
                "webaddress": "",
                "referenceNo": "",
                "tradingName": "YEMAWUS ENTERPRISE",
                "businessName": "YEMAWUS ENTERPRISE",
                "businessType": "SOLE PROPRIETORSH",
                "commercialID": 296079,
                "noOfDirectors": "0",
                "industrySector": "80",
                "postalAddress1": "",
                "postalAddress2": "",
                "postalAddress3": "",
                "postalAddress4": "",
                "commercialEmail1": "[email protected]",
                "commercialEmail2": "",
                "commercialEmail3": "",
                "commercialEmail4": "",
                "commercialAddress1": "26 TDC INDUSTRIAL ZONE",
                "commercialAddress2": "",
                "commercialAddress3": "",
                "commercialAddress4": "",
                "dateOfCommencement": "13/10/2021",
                "dateOfIncorporation": "13/10/2021",
                "previousBusinessName": "",
                "taxIdentificationNumber": "",
                "businessRegistrationNumber": "BN809081021",
                "previousRegistrationNumber": ""
            },
            "addressHistory": [{
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "01/03/2024",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "02/03/2023",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "05/06/2024",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "08/03/2024",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "08/06/2023",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "09/03/2023",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "23/10/2023",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "24/05/2024",
                "addressTypeInd": null
            }, {
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "upDateDate": null,
                "upDateOnDate": "31/05/2023",
                "addressTypeInd": null
            }],
            "directorInformation": [],
            "creditAccountSummary": {
                "rating": "2",
                "lastJudgementDateEUR": "",
                "lastJudgementDateGBP": "",
                "lastJudgementDateGHS": null,
                "lastJudgementDateUSD": null,
                "totalActiveAccountsEUR": "0",
                "totalActiveAccountsGBP": "0",
                "totalActiveAccountsGHS": "1",
                "totalActiveAccountsUSD": null,
                "totalAmountInArrearEUR": null,
                "totalAmountInArrearGBP": null,
                "totalAmountInArrearGHS": null,
                "totalAmountInArrearUSD": null,
                "totalClosedAccountsEUR": "0",
                "totalClosedAccountsGBP": "0",
                "totalClosedAccountsGHS": "0",
                "totalClosedAccountsUSD": null,
                "totalAccountInArrearEUR": null,
                "totalAccountInArrearGBP": null,
                "totalAccountInArrearGHS": null,
                "totalAccountInArrearUSD": null,
                "totalJudgementAmountEUR": "0",
                "totalJudgementAmountGBP": "0",
                "totalJudgementAmountGHS": null,
                "totalJudgementAmountUSD": null,
                "totalOutstandingdebtEUR": "0.00",
                "totalOutstandingdebtGBP": "0.00",
                "totalOutstandingdebtGHS": null,
                "totalOutstandingdebtUSD": null,
                "totalNumberofAccountsEUR": "0",
                "totalNumberofAccountsGBP": "0",
                "totalNumberofAccountsGHS": "1",
                "totalNumberofAccountsUSD": "0",
                "lastBouncedChequesDateEUR": "",
                "lastBouncedChequesDateGBP": "",
                "lastBouncedChequesDateGHS": null,
                "lastBouncedChequesDateUSD": null,
                "totalDishonouredAmountEUR": "0.00",
                "totalDishonouredAmountGBP": "0.00",
                "totalDishonouredAmountGHS": null,
                "totalDishonouredAmountUSD": null,
                "totalMonthlyInstalmentEUR": "0.00",
                "totalMonthlyInstalmentGBP": "0.00",
                "totalMonthlyInstalmentGHS": null,
                "totalMonthlyInstalmentUSD": null,
                "totalNumberofJudgementEUR": "0",
                "totalNumberofJudgementGBP": "0",
                "totalNumberofJudgementGHS": null,
                "totalNumberofJudgementUSD": null,
                "totalNumberofDishonouredEUR": "0",
                "totalNumberofDishonouredGBP": "0",
                "totalNumberofDishonouredGHS": null,
                "totalNumberofDishonouredUSD": null,
                "totalaccountinGoodconditionEUR": null,
                "totalaccountinGoodconditionGBP": null,
                "totalaccountinGoodconditionGHS": null,
                "totalaccountinGoodconditionUSD": null
            },
            "creditAgreementSummary": [{
                "currency": "GHS",
                "accountNo": "2022-592368",
                "closedDate": "",
                "subAccountNo": "",
                "amountOverdue": "16,350.00",
                "changedOnDate": "24/05/2024",
                "subscriberName": "CHRISLINE FINANCIAL SERVICES LTD",
                "monthsInArrears": null,
                "instalmentAmount": "16,350.00",
                "accountStatusCode": "2",
                "currentBalanceAmt": "32,700.00",
                "dateAccountOpened": "31/08/2022",
                "openingBalanceAmt": "30,000.00",
                "indicatorDescription": "Working Capital Loan",
                "currentBalanceDebitInd": "D"
            }],
            "highestDelinquencyRating": {
                "highestDelinquencyRating": "6"
            },
            "accountMonthlyPaymentHistory": [{
                "m01": "2",
                "m02": "#",
                "m03": "2",
                "m04": "#",
                "m05": "#",
                "m06": "#",
                "m07": "#",
                "m08": "#",
                "m09": "6",
                "m10": "6",
                "m11": "2",
                "m12": "6",
                "m13": "3",
                "m14": "3",
                "m15": "#",
                "m16": "0",
                "m17": "2",
                "m18": "#",
                "m19": "#",
                "m20": "#",
                "m21": "#",
                "m22": "#",
                "m23": "#",
                "m24": "#",
                "mH01": "2024 FEB",
                "mH02": "2024 JAN",
                "mH03": "2023 DEC",
                "mH04": "2023 NOV",
                "mH05": "2023 OCT",
                "mH06": "2023 SEP",
                "mH07": "2023 AUG",
                "mH08": "2023 JUL",
                "mH09": "2023 JUN",
                "mH10": "2023 MAY",
                "mH11": "2023 APR",
                "mH12": "2023 MAR",
                "mH13": "2023 FEB",
                "mH14": "2023 JAN",
                "mH15": "2022 DEC",
                "mH16": "2022 NOV",
                "mH17": "2022 OCT",
                "mH18": "2022 SEP",
                "mH19": "2022 AUG",
                "mH20": "2022 JUL",
                "mH21": "2022 JUN",
                "mH22": "2022 MAY",
                "mH23": "2022 APR",
                "mH24": "2022 MAR",
                "header": "Details of Credit Agreement with \u0022CHRISLINE FINANCIAL SERVICES LTD\u0022 for Account Number: 2022-592368",
                "company": "Company",
                "currency": "GHS",
                "accountNo": "2022-592368",
                "tableName": "Commercial24MonthlyPayment",
                "closedDate": "31/10/2023",
                "displayText": "Commercial 24 Monthly Payment",
                "subAccountNo": null,
                "amountOverdue": "16,350.00",
                "subscriberName": "CHRISLINE FINANCIAL SERVICES LTD",
                "lastUpdatedDate": "24/05/2024",
                "instalmentAmount": "16,350.00",
                "currentBalanceAmt": "32,700.00",
                "dateAccountOpened": "2022/08/31 12:00:00 AM",
                "openingBalanceAmt": "30,000.00",
                "dateAccountOpened1": "31/08/2022",
                "repaymentFrequency": "Monthly",
                "indicatorDescription": "Working Capital Loan",
                "currentBalanceDebitInd": "D"
            }]
        }
    }
}