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
| Key | Description |
|---|---|
| app-id | Your App ID |
| x-api-key | Your Secret Key |
Request Body
| Key | Description |
|---|---|
| rc_number | Company RC number |
| customer_name | Your 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
| Response | Description |
|---|---|
| status | Indicates that the request was successful. |
| detail | This field indicates the detail of the response. |
| response_code | Represents the response code. |
| data | It is a string that contains some encrypted or encoded data related to the verification. |
| SubjectList | This is an array of objects that represent the results of the CAC search. |
| CommercialID | The unique identifier for the commercial account. |
| SearchOutput | The full name and address of the commercial account. |
| Reference | A reference number for the commercial account search. |
| BusinessData | This is an object that represents the business details summary for a commercial account. |
| CommercialID | The unique identifier for the business. |
| ReferenceNo | A reference number for the business. |
| BusinessName | The name of the business. |
| TradingName | The trading name of the business. |
| IndustrySector | The industry sector that the business operates in. |
| PreviousBusinessName | The previous name of the business, if applicable. |
| BusinessRegistrationNumber | The registration number for the business. |
| PreviousRegistrationNumber | The previous registration number for the business, if applicable. |
| NoOfDirectors | The number of directors of the business. |
| BusinessType | The type of business, such as sole proprietorship, partnership, or corporation. |
| DateOfIncorporation | The date that the business was incorporated. |
| DateOfCommencement | The date that the business commenced operations. |
| TaxIdentificationNumber | The tax identification number for the business. |
| VatNumber | The VAT number for the business, if applicable. |
| Webaddress | The website address for the business. |
| CommercialEmail1 | The primary email address for the business. |
| CommercialEmail2 | The secondary email address for the business. |
| CommercialEmail3 | The tertiary email address for the business. |
| CommercialEmail4 | The quaternary email address for the business. |
| CommercialAddress1 | The first line of the business address. |
| CommercialAddress2 | The second line of the business address. |
| CommercialAddress3 | The third line of the business address. |
| CommercialAddress4 | The fourth line of the business address. |
| postalAddress1 | The first line of the postal address for the business. |
| postalAddress2 | The second line of the postal address for the business. |
| postalAddress3 | The third line of the postal address for the business. |
| postalAddress4 | The fourth line of the postal address for the business. |
| Telephone1 | The primary telephone number for the business. |
| Telephone2 | The secondary telephone number for the business. |
| Telephone3 | The tertiary telephone number for the business. |
| Telephone4 | The quaternary telephone number for the business. |
| Fax1 | The primary fax number for the business. |
| Fax2 | The secondary fax number for the business. |
| Fax3 | The tertiary fax number for the business. |
| Fax4 | The quaternary fax number for the business. |
| UpdatedOn | The date that the business data was last updated. |
| HighestDelinquencyRating | The 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. |
| FacilityPerformanceSummary | This is an object that represents the factory performance summary for a commercial account. |
| TotalMonthlyInstalment | The total monthly installment amount for all of the facility's accounts. |
| TotalOutstandingdebt | The total outstanding debt for all of the facility's accounts. |
| TotalAccountarrear | The total number of accounts that are in arrears. |
| Amountarrear | The total amount of money that is owed on the accounts that are in arrears. |
| TotalAccounts | The total number of accounts that the facility has. |
| TotalAccounts1 | The total number of accounts that are in good standing. |
| TotalaccountinGodcondition | The total number of accounts that are in good condition. |
| TotalaccountinGoodcondition | The total number of accounts that are in good condition. |
| TotalNumberofJudgement | The total number of judgments that have been issued against the facility. |
| TotalJudgementAmount | The total amount of money that is owed on the judgments that have been issued against the facility. |
| LastJudgementDate | The date of the most recent judgment that was issued against the facility. |
| TotalNumberofDishonoured | The total number of times that the facility has had a check or a payment bounced. |
| TotalDishonouredAmount | The total amount of money that has been lost due to bounced checks or payments. |
| LastBouncedChequesDate | The date of the most recent bounced check or payment. |
| Rating | The facility's credit rating. |
| DateAccountOpened | The date that the account was opened. |
| CreditAgreementSummary | This object provides a summary of the consumer's credit agreements. |
| SubscriberName | The name of the subscriber of the account. |
| AccountNo | The account number. |
| IndicatorDescription | A description of the account. |
| OpeningBalanceAmt | The opening balance of the account. |
| Currency | The currency of the account. |
| CurrentBalanceDebitInd | A flag indicating whether the current balance is a debit or credit. |
| CurrentBalanceAmt | The current balance of the account. |
| InstalmentAmount | The monthly installment amount for the account. |
| AmountOverdue | The amount of money that is overdue on the account. |
| ClosedDate | The date that the account was closed. |
| LastUpdatedDate | The date that the account was last updated. |
| PerformanceStatus | The performance status of the account. This can be "PERFORMING", "IN DEFAULT", or "CLOSED". |
| AccountStatus | The status of the account. This can be "OPEN", "CLOSED", or "IN DEFAULT". |
| AccountMonthlyPaymentHistoryHeader | This is an array of objects that represent the monthly payment history for an account. |
| TableName | The name of the table that contains the account monthly payment history. |
| DisplayText | The text that is displayed for the account monthly payment history. |
| Company | The name of the company that issued the account. |
| MH24 | The amount of money that was due on the account in the 24th month. |
| MH23 | The amount of money that was due on the account in the 23rd month. |
| MH22 | The amount of money that was due on the account in the 22nd month. |
| MH21 | The amount of money that was due on the account in the 21st month. |
| MH20 | The amount of money that was due on the account in the 20th month. |
| MH19 | The amount of money that was due on the account in the 19th month. |
| MH18 | The amount of money that was due on the account in the 18th month. |
| MH17 | The amount of money that was due on the account in the 17th month. |
| MH16 | The amount of money that was due on the account in the 16th month. |
| MH15 | The amount of money that was due on the account in the 15th month. |
| MH14 | The amount of money that was due on the account in the 14th month. |
| MH13 | The amount of money that was due on the account in the 13th month. |
| MH12 | The amount of money that was due on the account in the 12th month. |
| MH11 | The amount of money that was due on the account in the 11th month. |
| MH10 | The amount of money that was due on the account in the 10th month. |
| MH09 | The amount of money that was due on the account in the 9th month. |
| MH08 | The amount of money that was due on the account in the 8th month. |
| MH07 | The amount of money that was due on the account in the 7th month. |
| MH06 | The amount of money that was due on the account in the 6th month. |
| MH05 | The amount of money that was due on the account in the 5th month. |
| MH04 | The amount of money that was due on the account in the 4th month. |
| MH03 | The amount of money that was due on the account in the 3rd month. |
| MH02 | The amount of money that was due on the account in the 2nd month. |
| MH01 | The amount of money that was due on the account in the 1st month. |
| UpDateOnDate | The date that the address was updated. |
| AddressHistory | This property is an array of objects that represent the consumer's previous addresses. |
| CommercialAddressType | The type of address. Possible values are: Residential, Commercial. |
| CommercialAddress1 | The first line of the address. |
| CommercialAddress2 | The second line of the address. |
| CommercialAddress3 | The third line of the address. |
| CommercialAddress4 | The fourth line of the address. |
| AdditionalContactHistory | This property can contain multiple objects, one for each business that the consumer has been associated with. |
| CommercialID | The unique identifier for the business. |
| ReferenceNo | A reference number for the business. |
| BusinessName | The name of the business. |
| TradingName | The trading name of the business, if any. |
| IndustrySector | The industry sector that the business operates in. |
| PreviousBusinessName | The previous name of the business, if applicable. |
| BusinessRegistrationNumber | The business registration number. |
| PreviousRegistrationNumber | The previous business registration number, if applicable. |
| NoOfDirectors | The number of directors of the business. |
| BusinessType | The type of business, such as sole proprietorship, partnership, or limited liability company. |
| DateOfIncorporation | The date on which the business was incorporated. |
| DateOfCommencement | The date on which the business commenced operations. |
| TaxIdentificationNumber | The tax identification number for the business. |
| VatNumber | The value-added tax (VAT) number for the business, if applicable. |
| Webaddress | The website address for the business. |
| CommercialEmail1 | The primary email address for the business. |
| CommercialEmail2 | The secondary email address for the business. |
| CommercialEmail3 | The tertiary email address for the business. |
| CommercialEmail4 | The quaternary email address for the business. |
| CommercialAddress1 | The primary business address. |
| CommercialAddress2 | The secondary business address. |
| CommercialAddress3 | The tertiary business address. |
| CommercialAddress4 | The quaternary business address. |
| postalAddress1 | The primary postal address. |
| postalAddress2 | The secondary postal address. |
| postalAddress3 | The tertiary postal address. |
| postalAddress4 | The quaternary postal address. |
| Telephone1 | The primary telephone number for the business. |
| Telephone2 | The secondary telephone number for the business. |
| Telephone3 | The tertiary telephone number for the business. |
| Telephone4 | The quaternary telephone number for the business. |
| Fax1 | The primary fax number for the business. |
| Fax2 | The secondary fax number for the business. |
| Fax3 | The tertiary fax number for the business. |
| Fax4 | The quaternary fax number for the business. |
| UpdatedOn | The date on which the additional contact history was last updated. |
| EnquiryHistoryTop | This property can contain multiple objects, one for each enquiry that has been made by the consumer. |
| SubscriberEnquiryResultID | The unique identifier for the enquiry result. |
| DateRequested | The date on which the enquiry was requested. |
| SubscriberName | The name of the subscriber who requested the enquiry. |
| EnquiryReason | The reason for the enquiry. |
| EnquiryDetails | This is an array of multiple objects, one for each enquiry that the consumer has made. |
| SubscriberEnquiryResultID | The unique identifier for the enquiry result. |
| ProductID | The ID of the product that the consumer enquired about. |
| MatchingRate | The rate at which the consumer's credit profile matches the criteria for the product. |
| SubscriberEnquiryEngineID | The ID of the engine that processed the enquiry. |
Updated 9 months ago