Basic

Basic consumer credit bureau endpoint

TEST DATA mode:ID customer_name:Test Name number:11111111111 dob:1990-08-01

Get basic credit details of a user

POST {{BASE_URL}}/api/v2/biometrics/merchant/data/verification/credit_bureau/consumer/basic

Headers

Name	Type	Description
x-api-key*	String	your secret key
app-id*	String	your app id

Request Body

Name	Type	Description
mode*	String	ID or BIO
number	String	if mode is ID(Should be a BVN)
dob	String	if mode is BIO(Date of Birth)
customer_name*	String	name of customer
customer_reference*	String	unique customer reference

200: OK

{
    "status": true,
    "detail": "Credit Check successful",
    "response_code": "00",
    "data": [
        { 

        "PersonalDetailsSummary": [ 

            { 

                "ConsumerID": "", 

                "Header": " ", 

                "ReferenceNo": null, 

                "Nationality": "", 

                "NationalIDNo": "", 

                "PassportNo": null, 

                "DriversLicenseNo": null, 

                "BankVerificationNo": "", 

                "PencomIDNo": "", 

                "OtheridNo": "", 

                "BirthDate": "", 

                "Dependants": "0", 

                "Gender": "Female", 

                "MaritalStatus": null, 

                "ResidentialAddress1": "", 

                "ResidentialAddress2": "", 

                "ResidentialAddress3": "", 

                "ResidentialAddress4": " ", 

                "PostalAddress1": null, 

                "PostalAddress2": null, 

                "PostalAddress3": null, 

                "PostalAddress4": null, 

                "HomeTelephoneNo": null, 

                "WorkTelephoneNo": null, 

                "CellularNo": "", 

                "EmailAddress": "", 

                "EmployerDetail": null, 

                "PropertyOwnedType": "", 

                "Surname": "", 

                "FirstName": "", 

                "OtherNames": "" 

            } 

        ] 

    }, 

    { 

        "CreditAccountSummary": [ 

            { 

                "TotalMonthlyInstalment": "", 

                "TotalOutstandingdebt": "", 

                "TotalAccountarrear": "2", 

                "Amountarrear": "0.00", 

                "TotalAccounts": "6", 

                "TotalAccounts1": "0", 

                "TotalaccountinGodcondition": "5", 

                "TotalaccountinGoodcondition": "5", 

                "TotalNumberofJudgement": "0", 

                "TotalJudgementAmount": "0", 

                "LastJudgementDate": "-", 

                "TotalNumberofDishonoured": "0", 

                "TotalDishonouredAmount": "0.00", 

                "LastBouncedChequesDate": null, 

                "TotalMonthlyInstalment1": "0.00", 

                "TotalOutstandingdebt1": "0.00", 

                "TotalAccountarrear1": "0", 

                "Amountarrear1": "0.00", 

                "TotalaccountinGodcondition1": "0", 

                "TotalaccountinBadcondition": "0", 

                "TotalNumberofJudgement1": "0", 

                "TotalJudgementAmount1": "0", 

                "LastJudgementDate1": "-", 

                "TotalNumberofDishonoured1": "0", 

                "TotalDishonouredAmount1": "0.00", 

                "LastBouncedChequesDate1": null, 

                "Rating": "118" 

            } 

        ] 

    }, 

    { 

        "AccountRating": [ 

            { 

                "NoOfHomeLoanAccountsGood": "0", 

                "NoOfHomeLoanAccountsBad": "0", 

                "NoOfAutoLoanccountsGood": "0", 

                "NoOfAutoLoanAccountsBad": "0", 

                "NoOfStudyLoanAccountsGood": "0", 

                "NoOfStudyLoanAccountsBad": "0", 

                "NoOfPersonalLoanAccountsGood": "0", 

                "NoOfPersonalLoanAccountsBad": "0", 

                "NoOfCreditCardAccountsGood": "0", 

                "NoOfCreditCardAccountsBad": "0", 

                "NoOfRetailAccountsGood": "0", 

                "NoOfRetailAccountsBad": "0", 

                "NoOfJointLoanAccountsGood": "0", 

                "NoOfJointLoanAccountsBad": "0", 

                "NoOfTelecomAccountsGood": "0", 

                "NoOfTelecomAccountsBad": "0", 

                "NoOfOtherAccountsGood": "6", 

                "NoOfOtherAccountsBad": "0" 

            } 

        ] 

    }, 
    ]
}