Basic

Basic consumer credit bureau endpoint

TEST DATA customer_name: Test Name rc_number: 59002

Get basic credit details of a business

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

Headers

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

Request Body

Name	Type	Description
rc_number*	String	company RC number
customer_name*	String	name of customer
customer_reference*	String	unique customer reference

200: OK

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

            { 

                "CommercialID": null, 

                "ReferenceNo": null, 

                "BusinessName": null, 

                "TradingName": null, 

                "IndustrySector": null, 

                "PreviousBusinessName": null, 

                "BusinessRegistrationNumber": null, 

                "PreviousRegistrationNumber": null, 

                "NoOfDirectors": null, 

                "BusinessType": null, 

                "DateOfIncorporation": null, 

                "DateOfCommencement": null, 

                "TaxIdentificationNumber": null, 

                "VatNumber": null, 

                "Webaddress": null, 

                "CommercialEmail1": null, 

                "CommercialEmail2": null, 

                "CommercialEmail3": null, 

                "CommercialEmail4": null, 

                "CommercialAddress1": null, 

                "CommercialAddress2": null, 

                "CommercialAddress3": null, 

                "CommercialAddress4": null, 

                "postalAddress1": null, 

                "postalAddress2": null, 

                "postalAddress3": null, 

                "postalAddress4": null, 

                "Telephone1": null, 

                "Telephone2": null, 

                "Telephone3": null, 

                "Telephone4": null, 

                "Fax1": null, 

                "Fax2": null, 

                "Fax3": null, 

                "Fax4": null, 

                "UpdatedOn": null 

            } 

        ] 

    }, 

    { 

        "HighestDelinquencyRating": [ 

            { 

                "HighestDelinquencyRating": "-1" 

            } 

        ] 

    }, 

    { 

        "FacilityPerformanceSummary": [ 

            { 

                "TotalMonthlyInstalment": "0.00", 

                "TotalOutstandingdebt": "0.00", 

                "TotalAccountarrear": "0.00", 

                "TotalAccounts": "0", 

                "TotalAccounts1": "0", 

                "Amountarrear": "0.00", 

                "TotalaccountinGoodcondition": "0", 

                "TotalaccountinBadcondition": "0", 

                "TotalNumberofJudgement": "0", 

                "TotalJudgementAmount": "0", 

                "LastJudgementDate": "", 

                "TotalNumberofDishonoured": "0", 

                "TotalDishonouredAmount": "0.00", 

                "LastBouncedChequesDate": null, 

                "TotalMonthlyInstalment1": "0.00", 

                "TotalOutstandingdebt1": "0.00", 

                "TotalAccountarrear1": "0.00", 

                "Amountarrear1": "0.00", 

                "TotalaccountinGoodcondition1": "0", 

                "TotalaccountinBadcondition1": "0", 

                "TotalNumberofJudgement1": "0", 

                "TotalJudgementAmount1": "0", 

                "LastJudgementDate1": "", 

                "TotalNumberofDishonoured1": "0", 

                "TotalDishonouredAmount1": "0.00", 

                "LastBouncedChequesDate1": null, 

                "TotalNumberofAccounts": "0", 

                "Rating": null 

            } 
        ] 
    }, 
   ]
}