> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/core-api/transaction-details/background-check/kyb/credit-report.md).
# Credit Report
Specializing in business credit reports and housing data on over 365 million global businesses, we provide accurate and current information in a user-friendly format for businesses of all sizes. Endorsed by major credit insurers, our reports help verify the existence, activity, and trading status of a business, assessing potential financial and reputational risks. Our extensive coverage and depth of data make us an integral part of your Know Your Business (KYB) offering.
**Section**: `kybCreditReport`
**Required parameter:** `creditReportId`
Note: All fields returned by this API are optional and their presence cannot be guaranteed. Depending on the request or specific conditions, certain fields may not appear in the response.
{% tabs %}
{% tab title="Schema" %}
| Attribute | Type | Description |
| -------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | Internal company identification. |
| name | string | Registered company name/trading name of the business. |
| number | string | Official registration number. |
| vatRegistrationNumber | string | Local VAT Number. |
| registrationDate | date | The date the company was registered. |
| legalForm | string | The legal type of the company |
| country | string | Country where the company is registered (Alpha‑2 Code). |
| status | object | |
| status.status | string | High-level status. Values include "Active", "NonActive", "Pending" and "Other". |
| status.description | string | A more in-depth status value, based on local descriptions. |
| activities | array of objects | |
| activities.classification | string | The type of activity classification. |
| activities.code | string | Industry code used in that country. |
| activities.description | string | Description of company’s main activity. |
| activities.main | boolean | Indicate if the activity is the main activity of the company. |
| contact.phoneNumber | strings | Telephone number of the company. |
| contact.emails | array of strings | Email address for the company. |
| contact.websites | array of strings | Website address of the company. |
| contact.addresses | array of objects | |
| contact.addresses.fullAddress | string | Whole string address |
| contact.addresses.state | string | |
| contact.addresses.city | string | City portion of the address. |
| contact.addresses.postalCode | string | Postal code portion of the address. |
| contact.addresses.telephone | string | Telephone number of the address. |
| contact.addresses.main | boolean | Indicate if the address is the main address. |
| creditRating | object | |
| creditRating.internationalScore | string | Standardised credit score – will be A, B, C, D or E. |
| creditRating.creditLimit | object | |
| creditRating.creditLimit.currency | string | The Currency in which the financial value is displayed, as a three-character ISO code. |
| creditRating.creditLimit.value | string | Amount of credit advisable at any one time. |
| directors | array of objects | |
| directors.id | string | Internal director identification |
| directors.name | string | Full name of director |
| directors.title | String | Title of director. Values include "Miss", "Mr", "Mrs", "Ms". |
| directors.nationality | string | The director’s nationality or country of birth. |
| directors.birthDate | string | The director’s date of birth. |
| directors.gender | string | An standard description, as “Male”, “Female” or “Unknown”. |
| directors.isCurrent | boolean | Indicate if the director is a current director |
| directors.address | object | |
| directors.address.fullAddress | string | Whole string address. |
| directors.address.postalCode | string | Postal code portion of the address. |
| directors.address.city | string | City portion of the address |
| directors.address.state | string | |
| directors.address.country | string | The country where the directors details are registered. |
| directors.additionalData | object | |
| directors.additionalData.disqualified | boolean | |
| directors.additionalData.occupation | string | |
| directors.additionalData.presentAppointments | number | |
| directors.additionalData.dissolvedAppointments | number | |
| directors.additionalData.previousAppointments | number | |
| directors.additionalData.positions | array of objects | |
| directors.additionalData.positions.name | string | The director’s role/position in a company. |
| directors.additionalData.positions.dateAppointed | date | The date the director was appointed. |
| groupStructure | array of objects | |
| groupStructure.name | string | Full company name |
| groupStructure.level | number | The hierarchical level of the company within the group structure. |
| groupStructure.country | string | Country where the company is established. |
| groupStructure.number | string | Official registration number. |
| groupStructure.safeNumber | string | Internal company identification |
| groupStructure.status | string | High-level status. Values include "Active", "NonActive", "Pending" and "Other". |
| groupStructure.latestAnnualAccounts | date | The last filed financial statements Year End Date of the company. |
| groupStructure.address | object | |
| groupStructure.address.fullAddress | string | Whole string address |
| groupStructure.address.postalCode | string | Postal code portion of the address |
| groupStructure.address.city | string | City portion of the address |
| groupStructure.address.state | string | |
| groupStructure.address.country | string | Country where the address is registered. |
| groupStructure.relationType | object | |
| groupStructure.relationType.isUltimateParent | boolean | Indicate if the company is a ultimate parent. |
| groupStructure.relationType.isImmediateParent | boolean | Indicate if the company is a immediate parent. |
| groupStructure.relationType.isSubsidiaryCompany | boolean | Indicate if the company is a subsidiary company. |
| groupStructure.relationType.isAffiliatedCompany | boolean | Indicate if the company is a affiliated company. |
| otherInformation | object | |
| otherInformation.advisors | array of objects | |
| otherInformation.advisors.accountantName | string | Full name of the accountancy firm who responsible for preparing the accounts. |
| otherInformation.advisors.solicitorName | string | Name of solicitors. |
| otherInformation.advisors.auditorName | string | Full name of the company who is responsible for auditing. |
| otherInformation.employeesInformation | array of objects | |
| otherInformation.employeesInformation.year | number | Year that the figures were reordered. |
| otherInformation.employeesInformation.numberOfEmployees | string | Number of staff that the company employ directly. |
| localFinancialStatements | object | |
| localFinancialStatements.type | string | Type of the format representing how the accounts are presented. |
| localFinancialStatements.currency | String | Currency the figures are displayed in, as an ISO char(3) code. Examples GBP, EUR. |
| localFinancialStatements.yearEndDate | date | Year End to which the annual accounts relate. |
| localFinancialStatements.numberOfWeeks | number | The number of weeks covered by the accounts. |
| localFinancialStatements.consolidatedAccounts | boolean | Are the accounts consolidated? |
| localFinancialStatements.profitAndLoss | object | |
| localFinancialStatements.profitAndLoss.turnover | number | Total amount of income generated by the sale of goods and services. |
| localFinancialStatements.profitAndLoss.preTaxProfit | number | The results of the company before deducting any charge for taxation. |
| localFinancialStatements.balanceSheet | object | |
| localFinancialStatements.balanceSheet.totalShareholdersEquity | number | The total capital and reserves of the company. |
| localFinancialStatements.balanceSheet.tradeDebtors | number | Invoices owed to the company by customers. |
| localFinancialStatements.balanceSheet.tradeCreditors | number | Invoices owed by the company to suppliers and customers. |
| localFinancialStatements.cashFlow | object | |
| localFinancialStatements.cashFlow\.operatingActivities | number | Net cash inflow/outflow generated from operating activities. |
| localFinancialStatements.cashFlow\.investingActivities | number | Net cash inflow/outflow generated from investing activities. |
| localFinancialStatements.cashFlow\.financingActivities | number | Net cash inflow/outflow generated from financing activities. |
| localFinancialStatements.cashFlow\.netChangeInCash | number | Measures how much the value of Cash and Cash Equivalents changed over the reporting period. |
| localFinancialStatements.cashFlow\.cashAtBeginningOfYear | number | The amount of cash a company has at the start of the fiscal period. |
| localFinancialStatements.cashFlow\.exchangeRateEffect | number | The impact on the prices paid for imported products. |
| localFinancialStatements.cashFlow\.cashAndCashEquivalentsAtYearEnd | number | The amount of cash a company has at the end of the fiscal period (Balance Sheet “Cash” figure). |
| localFinancialStatements.cashFlow\.netCashFlowFromOperations | number | Net cash inflow/outflow from operations. |
| localFinancialStatements.cashFlow\.netCashFlowBeforeFinancing | number | Net cash inflow/outflow before financing. |
| localFinancialStatements.cashFlow\.netCashFlowFromFinancing | number | Net cash inflow/outflow from financing. |
| localFinancialStatements.cashFlow\.increaseInCash | number | Net increase/decrease in cash and cash equivalents for the year. |
| localFinancialStatements.cashFlow\.decreaseOrIncreaseInCash | number | The total increase or decrease in cash and cash equivalents for the period. |
| localFinancialStatements.cashFlow\.managementOfLiquidResources | number | Management of Liquid Resources. |
| localFinancialStatements.cashFlow\.equityDividendsPaid | number | The total amount of profits distributed to shareholders. |
| localFinancialStatements.cashFlow\.acquisitionsAndDisposals | number | The net cash/inflow/outflow arising from acquisitions/disposals. |
| localFinancialStatements.cashFlow\.capitalExpenditure | number | Net cash inflow/outflow arising from capital expenditure activities. |
| localFinancialStatements.cashFlow\.taxation | number | Net cash inflow/outflow arising from taxation. |
| localFinancialStatements.cashFlow\.returnOnInvestment | number | Net cash inflow/outflow generated from investing activities. |
| financialStatements | object | |
| financialStatements.type | string | Type of the format representing how the accounts are presented. |
| financialStatements.currency | string | The Currency in which the financial values are displayed, as a three-character ISO code. |
| financialStatements.yearEndDate | date | Financial Year End date for the annual accounts. |
| financialStatements.numberOfWeeks | number | Number of weeks in the year. |
| financialStatements.consolidatedAccounts | boolean | Are the accounts consolidated? |
| financialStatements.profitAndLoss | object | |
| financialStatements.profitAndLoss.turnover | number | |
| financialStatements.profitAndLoss.preTaxProfit | number | |
| financialStatements.profitAndLoss.revenue | number | Income earned from normal business activities, including the sale of goods and services. |
| financialStatements.profitAndLoss.operatingCosts | number | Costs incurred in the general running of the business. |
| financialStatements.profitAndLoss.operatingProfit | number | The results of the company after deducting Operating Costs from its Revenue. |
| financialStatements.profitAndLoss.wagesAndSalaries | number | Wages and salaries paid to employees of the company. Where possible this excludes Pensions. |
| financialStatements.profitAndLoss.pensionCosts | number | The cost of pension benefits for employees of the company. |
| financialStatements.profitAndLoss.depreciation | number | The amount written off Tangible Fixed Assets during the year. |
| financialStatements.profitAndLoss.amortisation | number | The amount written off Intangible Fixed Assets during the year. |
| financialStatements.profitAndLoss.financialExpenses | number | Interest expenses incurred during the year. |
| financialStatements.profitAndLoss.financialIncome | number | Interest income earned during the year. |
| financialStatements.profitAndLoss.extraordinaryIncome | number | Income arising due to events of a non-recurring nature. |
| financialStatements.profitAndLoss.extraordinaryCosts | number | Costs incurred due to events of a non-recurring nature. |
| financialStatements.profitAndLoss.tax | number | Taxation payable on the profits of the company. |
| financialStatements.profitAndLoss.profitAfterTax | number | The results of the company after deducting any charge for taxation. |
| financialStatements.profitAndLoss.dividends | number | The total amount of profits distributed to shareholders. |
| financialStatements.profitAndLoss.minorityInterests | number | Profits attributable to shareholders holding a minority interest in the company. |
| financialStatements.profitAndLoss.otherAppropriations | number | Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company |
| financialStatements.profitAndLoss.retainedProfit | number | The results of the company after all income and expenses have been credited/debited. |
| financialStatements.balanceSheet | object | |
| financialStatements.balanceSheet.landAndBuildings | number | Land and buildings owned by the company for long-term use. |
| financialStatements.balanceSheet.plantAndMachinery | number | Plant and machinery owned by the company for long-term use. |
| financialStatements.balanceSheet.otherTangibleAssets | number | Tangible fixed assets other than Land & Buildings or Plant & Machinery. |
| financialStatements.balanceSheet.totalTangibleAssets | number | Physical assets owned by the company for long-term use. |
| financialStatements.balanceSheet.goodwill | number | The premium paid or accumulated on the purchase of an asset. |
| financialStatements.balanceSheet.otherIntangibleAssets | number | Intangible fixed assets other than goodwill such as Trademarks, Patents, Research &
Development etc.
|
| financialStatements.balanceSheet.totalIntangibleAssets | number | Assets that have a value but no physical existence. |
| financialStatements.balanceSheet.investments | number | Long-term investments including shares and securities. |
| financialStatements.balanceSheet.loansToGroup | number | Long-term loans made by the company to related businesses. |
| financialStatements.balanceSheet.otherLoans | number | Other long-term loans made by the company. |
| financialStatements.balanceSheet.miscellaneousFixedAssets | number | Long-term assets other than Tangible Assets, Intangible Assets, Investments or Loans. |
| financialStatements.balanceSheet.totalOtherFixedAssets | number | Total long-term assets other than Tangible Assets or Intangible Assets. |
| financialStatements.balanceSheet.totalFixedAssets | number | The total of Tangible, Intangible and Other Fixed Assets. |
| financialStatements.balanceSheet.rawMaterials | number | Materials held by the company that have not yet been processed. |
| financialStatements.balanceSheet.workInProgress | number | Goods or contracts that are in the process of manufacture or completion. |
| financialStatements.balanceSheet.finishedGoods | number | Goods held that are ready for sale or use. |
| financialStatements.balanceSheet.otherInventories | number | Other amounts classed as Inventory but not included above. |
| financialStatements.balanceSheet.totalInventories | number | The total of stocks held by the company and work in progress. |
| financialStatements.balanceSheet.tradeReceivables | number | Amounts due within one year from customers for goods and services supplied on credit. |
| financialStatements.balanceSheet.groupReceivables | number | Amounts due within one year from related businesses. |
| financialStatements.balanceSheet.receivablesDueAfter1Year | number | Amounts due after one year owing to the company (including trade and group receivables due after one year). |
| financialStatements.balanceSheet.miscellaneousReceivables | number | Amounts due within one year owing to the company other than trade and group receivables. |
| financialStatements.balanceSheet.totalReceivables | number | Total amounts receivable by the company. |
| financialStatements.balanceSheet.cash | number | Cash at bank, cash in hand and cash equivalents. |
| financialStatements.balanceSheet.otherCurrentAssets | number | Any short-term assets that have not already been included as Inventory, Receivables or Cash. |
| financialStatements.balanceSheet.totalCurrentAssets | number | The total of Stocks, Debtors, Cash and other assets due within one year. |
| financialStatements.balanceSheet.totalAssets | number | The total of Current and Fixed Assets. |
| financialStatements.balanceSheet.tradePayables | number | Amount due within one year owing to suppliers for goods and services provided on credit. |
| financialStatements.balanceSheet.bankLiabilities | number | Amount due within one year owing to banks for overdrafts and loans. |
| financialStatements.balanceSheet.otherLoansOrFinance | number | Loans or finance due within one year owing to parties other than banks or related businesses. |
| financialStatements.balanceSheet.groupPayables | number | Amounts due within one year to related businesses. |
| financialStatements.balanceSheet.miscellaneousLiabilities | number | Other amounts due within one year owing by the company. |
| financialStatements.balanceSheet.totalCurrentLiabilities | number | Total short-term liabilities of the company. |
| financialStatements.balanceSheet.tradePayablesDueAfter1Year | number | Amount due after one year owing to suppliers for goods and services provided on credit. |
| financialStatements.balanceSheet.bankLiabilitiesDueAfter1Year | number | Amount due after one year owing to banks for overdrafts and loans. |
| financialStatements.balanceSheet.otherLoansOrFinanceDueAfter1Year | number | Loans or finance due after one year owing to parties other than banks or related businesses. |
| financialStatements.balanceSheet.groupPayablesDueAfter1Year | number | Amounts due after one year to related businesses. |
| financialStatements.balanceSheet.miscellaneousLiabilitiesDueAfter1Year | number | Other amounts due after one year owing by the company. |
| financialStatements.balanceSheet.totalLongTermLiabilities | number | Total long-term liabilities of the company. |
| financialStatements.balanceSheet.totalLiabilities | number | The total of Total Long-term Liabilities and Total Current Liabilities. |
| financialStatements.balanceSheet.calledUpShareCapital | number | The issued and paid share capital from shareholders. |
| financialStatements.balanceSheet.sharePremium | number | The excess of the amount received on the issue of shares over their value. |
| financialStatements.balanceSheet.revenueReserves | number | The accumulation of profits/losses from previous trading periods. |
| financialStatements.balanceSheet.otherReserves | number | Other capital and reserves that form part of shareholders equity. |
| financialStatements.balanceSheet.totalShareholdersEquity | number | The total capital and reserves of the company. |
| financialStatements.otherFinancials | Object | |
| financialStatements.otherFinancials.contingentLiabilities | number | Potential liabilities that are not recognised in the balance sheet, output as a string. Usually
contains integers, but can also be output as a string value (such as “YES” or “NO”).
|
| financialStatements.otherFinancials.workingCapital | number | Total Current Assets – Receivables Due after 1 year – Total Current Liabilities. This measures if the
company has sufficient short-term assets to cover its current debts.
|
| financialStatements.otherFinancials.netWorth | number | Often referred to as the 'book value' of the business this equals Total Shareholders’ Equity less
Total Intangible Assets.
|
| financialStatements.ratios | Object | |
| financialStatements.ratios.preTaxProfitMargin | number | Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the
equivalent of retailers 'mark-up'.
|
| financialStatements.ratios.returnOnCaptialEmployed | number | Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return
for the money (Capital) invested.
|
| financialStatements.ratios.returnOnTotalAssetsEmployed | number | Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or 'profit' on each pound of Assets
used as a percentage.
|
| financialStatements.ratios.returnOnNetAssetsEmployed | number | Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in percent on the net assets of the
company. The higher the percentage the more profitable the company.
|
| financialStatements.ratios.salesOrNetWorkingCapital | number | Turnover / (Total Current Assets - Receivables Due after 1 year - Total Current Liabilities). The
higher the ratio the higher the volume of Sales made per the companies working capital.
|
| financialStatements.ratios.stockTurnoverRatio | number | Stocks / Turnover x 100. This shows the number of times the trading stock of a company is ‘turned
over’ in a trading period. If the ratio is low this indicates that relatively little money is tied up in
Stocks.
|
| financialStatements.ratios.debtorDays | number | Trade Debtors / Turnover x 365 days. This is a calculation that predicts the average time taken for
the company to collect its invoices for goods and services provided to its customers.
|
| financialStatements.ratios.creditorDays | number | Trade Creditors / Turnover x 365 days. This is a calculation that predicts the average time taken
for the company to settle its invoices for goods and services provided by its suppliers.
|
| financialStatements.ratios.currentRatio | number | Total Current Assets - Receivables Due after 1 year / Total Current Liabilities. This is an indication
of a company's ability to meet short-term debt obligations; the higher the ratio, the more liquid the
company is.
|
| financialStatements.ratios.liquidityRatioOrAcidTest | number | Total Current Assets - Total Inventories - Receivables Due after 1 year / Total Current Liabilities.
This, like the current ratio, measures how quickly a company can meet its short-term debts.
However, this ratio excludes stock, as there is no guarantee the value of Stocks can be realised
quickly.
|
| financialStatements.ratios.currentDebtRatio | number | Total Current Liabilities / Total Shareholders’ Equity. This measures the amount of short-term debt
in relation to the value of shareholders’ funds.
|
| financialStatements.ratios.gearing | number | Bank Overdraft & Loans + Total Long-term Liabilities/Total Shareholders’ Equity x 100. This is the
relationship between the size of the company’s debt in proportion to Equity (Shareholders Funds).
|
| financialStatements.ratios.equityInPercentage | number | Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed Assets – Total Intangible
Assets) x 100. This ratio shows the worth of the company (shareholders’ funds) as a percentage
of total current and tangible assets.
|
| financialStatements.ratios.totalDebtRatio | number | Total Current Liabilities + Total Long-term liabilities / Total Shareholders’ Equity x 100. This shows
the relative indebtedness of a company in relation to the worth of the company.
|
| negativeInformation | object | |
| negativeInformation.summary | object | |
| negativeInformation.summary.currency | string | The ISO currency of the corresponding financial values. |
| negativeInformation.summary.numberOfExact | number | The number of exact match Unregistered County Court Judgments (CJ's). These will
remain on the public record for 6 years from the issue date of the Judgment.
|
| negativeInformation.summary.valueOfExact | number | The value of exact match Registered CCJ's. |
| negativeInformation.summary.numberOfSatisfied | number | The number of exact match Satisfied CCJ's. These will remain on the public record for 6
years from the issue date of the Judgment.
|
| negativeInformation.summary.numberOfWrits | number | The count of High Court Writs. |
| negativeInformation.summary.possibleRegistered | number | The number of possible match Registered County Court Judgments (CCJ's). These will
remain on the public record for 6 years (from the CCJ date).
|
| negativeInformation.summary.exactRegistered | number | The number of exact match Registered County Court Judgments (CCJ). These remain on
the public record for 6 years (from the CCJ date).
|
| negativeInformation.summary.numberOfPossible | number | The number of possible match Unregistered County Court Judgments (CJ's). These will
remain on the public record for 6 years (from the CCJ date).
|
| negativeInformation.summary.valueOfSatisfied | number | The value of exact match Satisfied CCJ's. |
| negativeInformation.countyCourtJudgements | object | |
| negativeInformation.countyCourtJudgements.registered | object | |
| negativeInformation.countyCourtJudgements.registered.exact | object | |
| negativeInformation.countyCourtJudgements.registered.exact.caseNumber | string | The case number of the judgment. |
| negativeInformation.countyCourtJudgements.registered.exact.court | string | The court in which the judgment was registered. |
| negativeInformation.countyCourtJudgements.registered.exact.date | date | The date that the judgment was registered in court. |
| negativeInformation.countyCourtJudgements.registered.exact.status | string | The status of the judgment. |
| negativeInformation.countyCourtJudgements.registered.exact.paidDate | date | The date that the judgment was satisfied. |
| negativeInformation.countyCourtJudgements.registered.exact.amount | number | The financial value of the judgment. |
| negativeInformation.countyCourtJudgements.registered.exact.currency | string | The currency in which a County Court Judgment has been issued. |
| negativeInformation.countyCourtJudgements.registered.exact.incomingRecordDetails | string | The name and address of the defendant as received by us. |
| negativeInformation.highCourtWrits | object | |
| negativeInformation.highCourtWrits.date | date | The date when the High Court Writ was issued. |
| negativeInformation.highCourtWrits.court | string | The High Court where the Writ was issued. |
| negativeInformation.highCourtWrits.plaintiff | string | The party responsible for bringing the claim (e.g. an escalated CCJ) to the High Court. |
| shareCapitalStructure | object | |
| shareCapitalStructure.issuedShareCapital | object | |
| shareCapitalStructure.issuedShareCapital.currency | string | The Currency in which the share values are displayed, as a three-character ISO code. |
| shareCapitalStructure.issuedShareCapital.value | number | |
| shareCapitalStructure.shareHolders | array | |
| shareCapitalStructure.shareHolders.name | string | Name of the Shareholder, or Company Name if a corporate shareholder exists. |
| shareCapitalStructure.shareHolders.currency | string | The Currency in which the share values are displayed, as a three-character ISO code. |
| shareCapitalStructure.shareHolders.totalNumberOfSharesOwned | number | The total number of all shares owned. |
| shareCapitalStructure.shareHolders.shareType | string | The share class, for example "Ordinary". |
| shareCapitalStructure.shareHolders.shareClassesValuePerShare | array of numbers | The value per share, also known as the par value. |
| shareCapitalStructure.shareHolders.percentSharesHeld | number | The total percentage of all shares held. Expressed as an integer, or to two decimal places. |
| shareCapitalStructure.shareHolders.issuedShareCapital | object | |
| shareCapitalStructure.shareHolders.issuedShareCapital.currency | string | The Currency in which the share values are displayed. |
| shareCapitalStructure.shareHolders.issuedShareCapital.value | number | This is the value of issued and paid share capital from shareholders. |
| additionalInformation.mortgageDetails | array | |
| additionalInformation.mortgageDetails.mortgageType | string | A description of the type of the mortgage charge. |
| additionalInformation.mortgageDetails.dateChargeCreated | date | The date that the mortgage charge was created. |
| additionalInformation.mortgageDetails.dateChargeRegistered | date | The date that the mortgage charge was registered. |
| additionalInformation.mortgageDetails.status | string | The status of the mortgage charge (outstanding or satisfied). |
| additionalInformation.mortgageDetails.personsEntitled | string | The name of the person or organisation entitled to the charge. |
| additionalInformation.mortgageDetails.amountSecured | string | The amount secured by the mortgage or charge. |
| additionalInformation.mortgageDetails.details | string | Further details of the particulars of the mortgage charge. |
| additionalInformation.miscellaneous | object | |
| additionalInformation.miscellaneous.ftseIndex | number | A count of land and property registered to the company, as confirmed via the HM Land Registry. |
| additionalInformation.miscellaneous.filingDateOfAccounts | string | The date accounts have been filed. |
| additionalInformation.miscellaneous.charityNumber | string | The date when the latest accounts were filed at the official registry. |
| additionalInformation.landRegistry | object | |
| additionalInformation.landRegistry.registeredLandAndProperty | number | |
| additionalInformation.personsWithSignificantControl | object | |
| additionalInformation.personsWithSignificantControl.active | object | |
| additionalInformation.personsWithSignificantControl.active.name | string | The name of a person or entity with significant control. |
| additionalInformation.personsWithSignificantControl.active.personType | string | High level person type Identifies. Include Person, Company or Other |
| additionalInformation.personsWithSignificantControl.active.country | string | The Country that a person with significant control of the company is based in. |
| additionalInformation.personsWithSignificantControl.active.notifiedOn | date | Date when the PSC details or changes were filed at Companies House |
| additionalInformation.personsWithSignificantControl.active.kind | string | Detailed person type identifies, include individual-person, corporate entity, legal-person or super-secure |
| additionalInformation.personsWithSignificantControl.active.natureOfControl | string | The nature of the person’s control of the company. |
| additionalInformation.personsWithSignificantControl.active.governingLaw | string | Governing law/legal authority under which the entity is bound. |
| additionalInformation.personsWithSignificantControl.active.insertDate | date | The date when the PSC record was received from Companies House. |
| additionalInformation.personsWithSignificantControl.active.legalForm | string | The stated Legal Form of the PSC legal entity. |
| additionalInformation.personsWithSignificantControl.active.placeRegistered | string | The place in which the company has been registered. |
| additionalInformation.personsWithSignificantControl.active.registrationNumber | string | The company registration number |
| additionalInformation.personsWithSignificantControl.active.countryOfRegistration | string | The country in which the company is registered |
| additionalInformation.personsWithSignificantControl.ceased | object | |
| additionalInformation.personsWithSignificantControl.ceased.name | string | The name of a person or entity with significant control. |
| additionalInformation.personsWithSignificantControl.ceased.personType | string | High level person type Identifies. Include Person, Company or Other |
| additionalInformation.personsWithSignificantControl.ceased.country | string | The Country that a person with significant control of the company is based in. |
| additionalInformation.personsWithSignificantControl.ceased.notifiedOn | date | Date when the PSC details or changes were filed at Companies House |
| additionalInformation.personsWithSignificantControl.ceased.kind | string | Detailed person type identifies, include individual-person, corporate entity, legal-person or super-secure |
| additionalInformation.personsWithSignificantControl.ceased.natureOfControl | string | The nature of the person’s control of the company. |
| additionalInformation.personsWithSignificantControl.ceased.governingLaw | string | Governing law/legal authority under which the entity is bound. |
| additionalInformation.personsWithSignificantControl.ceased.insertDate | date | The date when the PSC record was received from Companies House. |
| additionalInformation.personsWithSignificantControl.ceased.legalForm | string | The stated Legal Form of the PSC legal entity. |
| additionalInformation.personsWithSignificantControl.ceased.placeRegistered | string | The place in which the company has been registered. |
| additionalInformation.personsWithSignificantControl.ceased.registrationNumber | string | The company registration number |
| additionalInformation.personsWithSignificantControl.ceased.countryOfRegistration | string | The country in which the company is registered |
| additionalInformation.commentaries | string | Score Commentary |
| additionalInformation.commentaries.text | string | The commentary highlights various evolving trends within the business. |
| additionalInformation.commentaries.indicator | string | This shows an arrow indicating if the trend has improved or decreased. Possible values are "Positive", "Negative" or "Neutral". |
| {% endtab %} | | |
{% tab title="Example" %}
```json
{
"id": "Id",
"name": "Company name",
"registrationDate": "1970-01-01T00:00:00Z",
"country": "GB",
"number": "123",
"vatRegistrationNumber": "456",
"legalForm": "Public limited",
"status": {
"description": "Active - Accounts Filed",
"code": "Active"
},
"additionalInformation": {
"mortgageDetails": [
{
"dateChargeCreated": "1970-01-01T00:00:00Z",
"mortgageType": "String",
"personsEntitled": "String",
"details": "String",
"dateChargeRegistered": "1970-01-01T00:00:00Z",
"amountSecured": "String",
"status": "String"
}
],
"landRegistry": {
"registeredLandAndProperty": 3
},
"miscellaneous": {
"filingDateOfAccounts": "1970-01-01T00:00:00Z",
"ftseIndex": "String"
},
"commentaries": [
{
"text": "String",
"indicator": "Positive",
}
]
},
"groupStructure": [
{
"id": "Id",
"country": "GB",
"name": "Name",
"status": "Active",
"level": 0,
"address": {
"fullAddress": "Address"
},
"latestAnnualAccounts": "1970-01-01T00:00:00Z",
"relationType": {
"isUltimateParent": true
}
}
],
"directors": [
{
"id": "Id",
"name": "Name",
"gender": "Male",
"title": "Mr",
"birthDate": "1970-01-01T00:00:00Z",
"address": {
"fullAddress": "Full address"
},
"additionalData": {
"positions": [
{
"name": "Director",
"dateAppointed": "1970-01-01T00:00:00Z"
}
],
"disqualified": false,
"occupation": "DIRECTOR",
"disqualifiedException": false,
"presentAppointments": 1
},
"isCurrent": true
}
],
"shareCapitalStructure": {
"shareHolders": [
{
"name": "Name",
"currency": "GBP",
"shareClassesValuePerShare": [0.0],
"percentSharesHeld": 0,
"shareType": "ORDINARY",
"totalNumberOfSharesOwned": 0
}
],
"issuedShareCapital": {
"value": 0,
"currency": "GBP"
}
},
"otherInformation": {
"advisors": [
{
"auditorName": "Auditor"
}
],
"employeesInformation": [
{
"year": 2023,
"numberOfEmployees": "0"
}
]
},
"activities": [
{
"description": "Description",
"main": true,
"code": "123",
"classification": "SIC07"
}
],
"contact": {
"websites": ["www.website.com"],
"phoneNumber": "123456789",
"addresses": [
{
"fullAddress": "Address",
"phoneNumber": "123456789",
"city": "City",
"postalCode": "AAA BBB",
"main": true
}
]
},
"negativeInformation": {
"summary": {
"numberOfExact": 0,
"valueOfExact": 0,
"numberOfSatisfied": 0,
"numberOfWrits": 0,
"possibleRegistered": 0,
"currency": "GBP",
"exactRegistered": 0,
"numberOfPossible": 0,
"valueOfSatisfied": 0
},
"countyCourtJudgements": {
"registered": {
"exact": [
{
"date": "1970-01-01T00:00:00Z",
"amount": 0,
"incomingRecordDetails": "String",
"caseNumber": "String",
"currency": "GBP",
"court": "String",
"status": "Judgment"
}
]
}
}
},
"financialStatements": [
{
"type": "GlobalFinancialsGGS",
"profitAndLoss": {
"amortisation": 0,
"wagesAndSalaries": 0,
"tax": -0,
"retainedProfit": -0,
"revenue": 0,
"operatingCosts": 0,
"profitAfterTax": 0,
"financialExpenses": 0,
"dividends": 0,
"depreciation": 0,
"minorityInterests": -0,
"operatingProfit": 0,
"pensionCosts": 0,
"otherAppropriations": 0
},
"otherFinancials": {
"workingCapital": 0,
"contingentLiabilities": "NO",
"netWorth": 0
},
"yearEndDate": "1970-01-01T00:00:00Z",
"consolidatedAccounts": true,
"currency": "GBP",
"numberOfWeeks": 0,
"balanceSheet": {
"totalAssets": 0,
"otherReserves": 0,
"miscellaneousReceivables": 0,
"miscellaneousLiabilities": 0,
"miscellaneousLiabilitiesDueAfter1Year": 0,
"totalCurrentLiabilities": 0,
"otherCurrentAssets": 0,
"revenueReserves": 0,
"totalReceivables": 0,
"totalTangibleAssets": 0,
"cash": 0,
"otherLoansOrFinance": 0,
"totalShareholdersEquity": 0,
"tradeReceivables": 0,
"totalOtherFixedAssets": 0,
"bankLiabilitiesDueAfter1Year": 0,
"totalCurrentAssets": 0,
"totalLiabilities": 0,
"otherLoansOrFinanceDueAfter1Year": 0,
"totalLongTermLiabilities": 0,
"totalFixedAssets": 0,
"calledUpShareCapital": 0,
"totalInventories": 0,
"totalIntangibleAssets": 0,
"bankLiabilities": 0
},
"ratios": {
"currentDebtRatio": 0,
"equityInPercentage": 0,
"debtorDays": 0,
"returnOnNetAssetsEmployed": 0,
"stockTurnoverRatio": 0,
"returnOnTotalAssetsEmployed": 0,
"creditorDays": 0,
"liquidityRatioOrAcidTest": 0,
"totalDebtRatio": 0,
"preTaxProfitMargin": 0,
"gearing": 0,
"salesOrNetWorkingCapital": -0,
"currentRatio": 0
}
}
],
"localFinancialStatements": [
{
"type": "LocalFinancials",
"yearEndDate": "1970-01-01T00:00:00Z",
"cashFlow": {
"increaseInCash": 0,
"netCashFlowFromFinancing": 0,
"netCashFlowBeforeFinancing": 0,
"netCashFlowFromOperations": 0
},
"consolidatedAccounts": true,
"currency": "GBP",
"numberOfWeeks": 0,
"balanceSheet": {
"tradeDebtors": 0,
"tradeCreditors": 0,
"totalShareholdersEquity": 0
}
}
],
"creditRating": {
"creditLimit": {
"value": "0",
"currency": "GBP"
},
"internationalScore": "A"
}
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.caf.io/caf-api/core-api/transaction-details/background-check/kyb/credit-report.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.