Credit Bureau Commercial(Business)-Advance

Get advance credit details of a business

This endpoint gives businesses unparalleled insight into a business's credit details. With this endpoint, businesses can instantly determine a business's creditworthiness. It also provides a range of responses, including total dishonoured amounts, monthly installments, credit utilization ratio, payment history, credit score. and total numbers of accounts.

πŸ‘

TEST DATA

rc_number: 59001

customer_ name: Test Name

πŸ“˜

POST

{{URL}}/identitypass/verification/credit_bureau/commercial/advance

Request Header

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Request Body

KeyDescription
rc_numberCompany RC number
customer_nameYour customer's name

Sample Response

{
    "status": true,
    "detail": "Credit Check successful",
    "response_code": "00",
    "data": [
        {
            "SubjectList": [
                {
                    "CommercialID": null,
                    "SearchOutput": null,
                    "Reference": null
                }
            ]
        },
        {
            "BusinessData": [
                {
                    "CommercialID": "853535",
                    "ReferenceNo": null,
                    "BusinessName": "OCH TEST DUMMY 5",
                    "TradingName": null,
                    "IndustrySector": "",
                    "PreviousBusinessName": "",
                    "BusinessRegistrationNumber": "",
                    "PreviousRegistrationNumber": null,
                    "NoOfDirectors": "0",
                    "BusinessType": "",
                    "DateOfIncorporation": "30/07/2018",
                    "DateOfCommencement": null,
                    "TaxIdentificationNumber": "NIL",
                    "VatNumber": null,
                    "Webaddress": null,
                    "CommercialEmail1": null,
                    "CommercialEmail2": null,
                    "CommercialEmail3": null,
                    "CommercialEmail4": null,
                    "CommercialAddress1": "UBA HOUSE 57 MARINA",
                    "CommercialAddress2": "",
                    "CommercialAddress3": "",
                    "CommercialAddress4": "",
                    "postalAddress1": "UBA HOUSE 57 MARINAADD",
                    "postalAddress2": "RESS L",
                    "postalAddress3": "",
                    "postalAddress4": "",
                    "Telephone1": null,
                    "Telephone2": null,
                    "Telephone3": null,
                    "Telephone4": null,
                    "Fax1": null,
                    "Fax2": null,
                    "Fax3": null,
                    "Fax4": null,
                    "UpdatedOn": "11/01/2022"
                }
            ]
        },
        {
            "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",
                    "LastDishonouredChequeDate": "0",
                    "Rating": null
                }
            ]
        },
        {
            "DirectorInformation": [
                {
                    "Directorid": null,
                    "DateofBirth": null,
                    "firstName": null,
                    "othernames": null,
                    "surname": null,
                    "Identificationnumber": null,
                    "DirectorAppointmentdate": null
                }
            ]
        },
        {
            "CreditAgreementSummary": [
                {
                    "DateAccountOpened": null,
                    "SubscriberName": null,
                    "AccountNo": null,
                    "IndicatorDescription": null,
                    "OpeningBalanceAmt": null,
                    "Currency": null,
                    "CurrentBalanceDebitInd": null,
                    "CurrentBalanceAmt": null,
                    "InstalmentAmount": null,
                    "AmountOverdue": null,
                    "ClosedDate": null,
                    "LastUpdatedDate": null,
                    "PerformanceStatus": null,
                    "AccountStatus": null
                }
            ]
        },
        {
            "AccountMonthlyPaymentHistoryHeader": [
                {
                    "TableName": null,
                    "DisplayText": null,
                    "Company": null,
                    "MH24": null,
                    "MH23": null,
                    "MH22": null,
                    "MH21": null,
                    "MH20": null,
                    "MH19": null,
                    "MH18": null,
                    "MH17": null,
                    "MH16": null,
                    "MH15": null,
                    "MH14": null,
                    "MH13": null,
                    "MH12": null,
                    "MH11": null,
                    "MH10": null,
                    "MH09": null,
                    "MH08": null,
                    "MH07": null,
                    "MH06": null,
                    "MH05": null,
                    "MH04": null,
                    "MH03": null,
                    "MH02": null,
                    "MH01": null
                }
            ]
        },
        {
            "AccountMonthlyPaymentHistory": [
                {
                    "Header": "Details of Credit Agreement with \"United Bank for Africa Lagos\" for Account Number: 1021392523",
                    "TableName": "Commercial24MonthlyPayment",
                    "DisplayText": "Commercial 24 Monthly Payment",
                    "AccountOpenedDate": "Jan  1 2000 12:00AM",
                    "SubscriberName": "United Bank for Africa Lagos",
                    "AccountNo": "1021392523",
                    "Currency": "NGN",
                    "CurrentBalanceDebitInd": "",
                    "DateAccountOpened": "01/01/2000",
                    "IndicatorDescription": "COMMERCIAL OVERDRAFT",
                    "OpeningBalanceAmt": "0.00",
                    "CurrentBalanceAmt": "2,674,591.08",
                    "MonthlyInstalmentAmt": "0.00",
                    "AmountOverdue": null,
                    "ClosedDate": "01/01/2000",
                    "LastUpdatedDate": "11/01/2022",
                    "LastPaymentDate": "",
                    "PerformanceStatus": "PERFORMING",
                    "SubscriberTypeInd": "C",
                    "AccountNote": "",
                    "LoanDuration": "0 Day(s)",
                    "RepaymentFrequencyCode": "Not Available",
                    "AccountStatus": "OPEN",
                    "M24": "0",
                    "M23": "0",
                    "M22": "759",
                    "M21": "790",
                    "M20": "820",
                    "M19": "851",
                    "M18": "881",
                    "M17": "912",
                    "M16": "#",
                    "M15": "#",
                    "M14": "0",
                    "M13": "0",
                    "M12": "0",
                    "M11": "#",
                    "M10": "#",
                    "M09": "#",
                    "M08": "#",
                    "M07": "#",
                    "M06": "#",
                    "M05": "#",
                    "M04": "#",
                    "M03": "#",
                    "M02": "#",
                    "M01": "#"
                }
            ]
        },
        {
            "AddressHistory": [
                {
                    "UpDateOnDate": null,
                    "CommercialAddressType": null,
                    "CommercialAddress1": null,
                    "CommercialAddress2": null,
                    "CommercialAddress3": null,
                    "CommercialAddress4": null
                }
            ]
        },
        {
            "AdditionalContactHistory": [
                {
                    "CommercialID": "853535",
                    "ReferenceNo": null,
                    "BusinessName": "OCH TEST DUMMY 5",
                    "TradingName": null,
                    "IndustrySector": "",
                    "PreviousBusinessName": "",
                    "BusinessRegistrationNumber": "",
                    "PreviousRegistrationNumber": null,
                    "NoOfDirectors": "0",
                    "BusinessType": "",
                    "DateOfIncorporation": "30/07/2018",
                    "DateOfCommencement": null,
                    "TaxIdentificationNumber": "NIL",
                    "VatNumber": null,
                    "Webaddress": null,
                    "CommercialEmail1": null,
                    "CommercialEmail2": null,
                    "CommercialEmail3": null,
                    "CommercialEmail4": null,
                    "CommercialAddress1": "UBA HOUSE 57 MARINA",
                    "CommercialAddress2": "",
                    "CommercialAddress3": "",
                    "CommercialAddress4": "",
                    "postalAddress1": "UBA HOUSE 57 MARINAADD",
                    "postalAddress2": "RESS L",
                    "postalAddress3": "",
                    "postalAddress4": "",
                    "Telephone1": null,
                    "Telephone2": null,
                    "Telephone3": null,
                    "Telephone4": null,
                    "Fax1": null,
                    "Fax2": null,
                    "Fax3": null,
                    "Fax4": null,
                    "UpdatedOn": "11/01/2022"
                }
            ]
        },
        {
            "EnquiryHistoryTop": [
                {
                    "SubscriberEnquiryResultID": null,
                    "DateRequested": null,
                    "SubscriberName": null,
                    "EnquiryReason": null
                }
            ]
        },
        {
            "EnquiryDetails": [
                {
                    "SubscriberEnquiryResultID": null,
                    "ProductID": null,
                    "MatchingRate": null,
                    "SubscriberEnquiryEngineID": null
                }
            ]
        }
    ]
}

Response Description

ResponseDescription
statusIndicates that the request was successful.
detailThis field indicates the detail of the response.
response_codeRepresents the response code.
dataIt is a string that contains some encrypted or encoded data related to the verification.
SubjectListThis is an array of objects that represent the results of the CAC search.
CommercialIDThe unique identifier for the commercial account.
SearchOutputThe full name and address of the commercial account.
ReferenceA reference number for the commercial account search.
BusinessDataThis is an object that represents the business details summary for a commercial account.
CommercialIDThe unique identifier for the business.
ReferenceNoA reference number for the business.
BusinessNameThe name of the business.
TradingNameThe trading name of the business.
IndustrySectorThe industry sector that the business operates in.
PreviousBusinessNameThe previous name of the business, if applicable.
BusinessRegistrationNumberThe registration number for the business.
PreviousRegistrationNumberThe previous registration number for the business, if applicable.
NoOfDirectorsThe number of directors of the business.
BusinessTypeThe type of business, such as sole proprietorship, partnership, or corporation.
DateOfIncorporationThe date that the business was incorporated.
DateOfCommencementThe date that the business commenced operations.
TaxIdentificationNumberThe tax identification number for the business.
VatNumberThe VAT number for the business, if applicable.
WebaddressThe website address for the business.
CommercialEmail1The primary email address for the business.
CommercialEmail2The secondary email address for the business.
CommercialEmail3The tertiary email address for the business.
CommercialEmail4The quaternary email address for the business.
CommercialAddress1The first line of the business address.
CommercialAddress2The second line of the business address.
CommercialAddress3The third line of the business address.
CommercialAddress4The fourth line of the business address.
postalAddress1The first line of the postal address for the business.
postalAddress2The second line of the postal address for the business.
postalAddress3The third line of the postal address for the business.
postalAddress4The fourth line of the postal address for the business.
Telephone1The primary telephone number for the business.
Telephone2The secondary telephone number for the business.
Telephone3The tertiary telephone number for the business.
Telephone4The quaternary telephone number for the business.
Fax1The primary fax number for the business.
Fax2The secondary fax number for the business.
Fax3The tertiary fax number for the business.
Fax4The quaternary fax number for the business.
UpdatedOnThe date that the business data was last updated.
HighestDelinquencyRatingThe highest delinquency rating for any of the consumer's accounts. A delinquency rating is a number that represents the extent to which an account is in arrears.
FacilityPerformanceSummaryThis is an object that represents the factory performance summary for a commercial account.
TotalMonthlyInstalmentThe total monthly installment amount for all of the facility's accounts.
TotalOutstandingdebtThe total outstanding debt for all of the facility's accounts.
TotalAccountarrearThe total number of accounts that are in arrears.
AmountarrearThe total amount of money that is owed on the accounts that are in arrears.
TotalAccountsThe total number of accounts that the facility has.
TotalAccounts1The total number of accounts that are in good standing.
TotalaccountinGodconditionThe total number of accounts that are in good condition.
TotalaccountinGoodconditionThe total number of accounts that are in good condition.
TotalNumberofJudgementThe total number of judgments that have been issued against the facility.
TotalJudgementAmountThe total amount of money that is owed on the judgments that have been issued against the facility.
LastJudgementDateThe date of the most recent judgment that was issued against the facility.
TotalNumberofDishonouredThe total number of times that the facility has had a check or a payment bounced.
TotalDishonouredAmountThe total amount of money that has been lost due to bounced checks or payments.
LastBouncedChequesDateThe date of the most recent bounced check or payment.
RatingThe facility's credit rating.
DateAccountOpenedThe date that the account was opened.
CreditAgreementSummaryThis object provides a summary of the consumer's credit agreements.
SubscriberNameThe name of the subscriber of the account.
AccountNoThe account number.
IndicatorDescriptionA description of the account.
OpeningBalanceAmtThe opening balance of the account.
CurrencyThe currency of the account.
CurrentBalanceDebitIndA flag indicating whether the current balance is a debit or credit.
CurrentBalanceAmtThe current balance of the account.
InstalmentAmountThe monthly installment amount for the account.
AmountOverdueThe amount of money that is overdue on the account.
ClosedDateThe date that the account was closed.
LastUpdatedDateThe date that the account was last updated.
PerformanceStatusThe performance status of the account. This can be "PERFORMING", "IN DEFAULT", or "CLOSED".
AccountStatusThe status of the account. This can be "OPEN", "CLOSED", or "IN DEFAULT".
AccountMonthlyPaymentHistoryHeaderThis is an array of objects that represent the monthly payment history for an account.
TableNameThe name of the table that contains the account monthly payment history.
DisplayTextThe text that is displayed for the account monthly payment history.
CompanyThe name of the company that issued the account.
MH24The amount of money that was due on the account in the 24th month.
MH23The amount of money that was due on the account in the 23rd month.
MH22The amount of money that was due on the account in the 22nd month.
MH21The amount of money that was due on the account in the 21st month.
MH20The amount of money that was due on the account in the 20th month.
MH19The amount of money that was due on the account in the 19th month.
MH18The amount of money that was due on the account in the 18th month.
MH17The amount of money that was due on the account in the 17th month.
MH16The amount of money that was due on the account in the 16th month.
MH15The amount of money that was due on the account in the 15th month.
MH14The amount of money that was due on the account in the 14th month.
MH13The amount of money that was due on the account in the 13th month.
MH12The amount of money that was due on the account in the 12th month.
MH11The amount of money that was due on the account in the 11th month.
MH10The amount of money that was due on the account in the 10th month.
MH09The amount of money that was due on the account in the 9th month.
MH08The amount of money that was due on the account in the 8th month.
MH07The amount of money that was due on the account in the 7th month.
MH06The amount of money that was due on the account in the 6th month.
MH05The amount of money that was due on the account in the 5th month.
MH04The amount of money that was due on the account in the 4th month.
MH03The amount of money that was due on the account in the 3rd month.
MH02The amount of money that was due on the account in the 2nd month.
MH01The amount of money that was due on the account in the 1st month.
UpDateOnDateThe date that the address was updated.
AddressHistoryThis property is an array of objects that represent the consumer's previous addresses.
CommercialAddressTypeThe type of address. Possible values are: Residential, Commercial.
CommercialAddress1The first line of the address.
CommercialAddress2The second line of the address.
CommercialAddress3The third line of the address.
CommercialAddress4The fourth line of the address.
AdditionalContactHistoryThis property can contain multiple objects, one for each business that the consumer has been associated with.
CommercialIDThe unique identifier for the business.
ReferenceNoA reference number for the business.
BusinessNameThe name of the business.
TradingNameThe trading name of the business, if any.
IndustrySectorThe industry sector that the business operates in.
PreviousBusinessNameThe previous name of the business, if applicable.
BusinessRegistrationNumberThe business registration number.
PreviousRegistrationNumberThe previous business registration number, if applicable.
NoOfDirectorsThe number of directors of the business.
BusinessTypeThe type of business, such as sole proprietorship, partnership, or limited liability company.
DateOfIncorporationThe date on which the business was incorporated.
DateOfCommencementThe date on which the business commenced operations.
TaxIdentificationNumberThe tax identification number for the business.
VatNumberThe value-added tax (VAT) number for the business, if applicable.
WebaddressThe website address for the business.
CommercialEmail1The primary email address for the business.
CommercialEmail2The secondary email address for the business.
CommercialEmail3The tertiary email address for the business.
CommercialEmail4The quaternary email address for the business.
CommercialAddress1The primary business address.
CommercialAddress2The secondary business address.
CommercialAddress3The tertiary business address.
CommercialAddress4The quaternary business address.
postalAddress1The primary postal address.
postalAddress2The secondary postal address.
postalAddress3The tertiary postal address.
postalAddress4The quaternary postal address.
Telephone1The primary telephone number for the business.
Telephone2The secondary telephone number for the business.
Telephone3The tertiary telephone number for the business.
Telephone4The quaternary telephone number for the business.
Fax1The primary fax number for the business.
Fax2The secondary fax number for the business.
Fax3The tertiary fax number for the business.
Fax4The quaternary fax number for the business.
UpdatedOnThe date on which the additional contact history was last updated.
EnquiryHistoryTopThis property can contain multiple objects, one for each enquiry that has been made by the consumer.
SubscriberEnquiryResultIDThe unique identifier for the enquiry result.
DateRequestedThe date on which the enquiry was requested.
SubscriberNameThe name of the subscriber who requested the enquiry.
EnquiryReasonThe reason for the enquiry.
EnquiryDetailsThis is an array of multiple objects, one for each enquiry that the consumer has made.
SubscriberEnquiryResultIDThe unique identifier for the enquiry result.
ProductIDThe ID of the product that the consumer enquired about.
MatchingRateThe rate at which the consumer's credit profile matches the criteria for the product.
SubscriberEnquiryEngineIDThe ID of the engine that processed the enquiry.