# Company Credit Report Orders a Company Credit Report by connectId. To acquire a PDF version of the report use the optional request in 'Header'. This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response. Endpoint: GET /companies/{connectId} Version: 1.10.9 Security: bearerToken ## Header parameters: - `Accept` (any) Specifies the desired response format. Example: "application/pdf" ## Query parameters: - `language` (string,null) Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available. - `template` (string,null) Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use. Connect Report Templates - `includeIndicators` (boolean) Optional parameter to include the indicator scores in to a company report - , , , Addition information on indicator acronyms can be found HERE. Addition information on understanding indicators can be found HERE. - `customData` (string,null) Additional Report Parameters e.g. German Report Reason Code value is . Use /reportcustomdata/{country} endpoint to see all values. - `callRef` (string,null) This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions. ## Path parameters: - `connectId` (string, required) The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from search results. Example: "GB-0-03836192" ## Response 200 fields (application/json): - `correlationId` (string) A unique ID assigned to this request. - `failedSections` (array) Enum: "CompanySummary", "CompanySummaryExtra", "AlternateSummary", "CompanyIdentification", "CompanyIdentificationExtra", "CreditScore", "CreditScoreExtra", "ContactInformation", "ContactInformationExtra", "ShareCapitalStructure", "ShareCapitalStructureExtra", "Directors", "DirectorsExtra", "Directorships", "DirectorshipsExtra", "OtherInformation", "OtherInformationExtra", "GroupStructure", "GroupStructureExtra", "ExtendedGroupStructure", "ExtendedGroupStructureExtra", "GlobalFinancialStatements", "GlobalFinancialStatementsExtra", "LocalFinancialStatements", "LocalFinancialStatementsExtra", "PaymentData", "PaymentDataExtra", "NegativeInformation", "NegativeInformationExtra", "AdditionalInformation", "AdditionalInformationExtra", "UPPData", "Unused" - `report` (object) - `report.companyId` (string) - `report.language` (string) Enum: "OM", "AB", "AA", "AF", "SQ", "AM", "AR", "HY", "AS", "AY", "AZ", "BA", "EU", "BN", "DZ", "BH", "BI", "BR", "BG", "MY", "BE", "KM", "CA", "ZH", "CO", "HR", "CS", "DA", "NL", "EN", "EO", "ET", "FO", "FJ", "FI", "FR", "FY", "GL", "KA", "DE", "EL", "KL", "GN", "GU", "HA", "HE", "HI", "HU", "IS", "ID", "IA", "IE", "IK", "IU", "GA", "IT", "JA", "JW", "KN", "KS", "KK", "RW", "KY", "RN", "KO", "KU", "LO", "LA", "LV", "LN", "LT", "MK", "MG", "MS", "ML", "MT", "MI", "MR", "MO", "MN", "NA", "NE", "NO", "OC", "OR", "PS", "FA", "PL", "PT", "PA", "QU", "RM", "RO", "RU", "SM", "SG", "SA", "GD", "SR", "SH", "ST", "TN", "SN", "SD", "SI", "SS", "SK", "SL", "SO", "ES", "SU", "SW", "SV", "TL", "TG", "TA", "TT", "TE", "TH", "BO", "TI", "TO", "TS", "TR", "TK", "TW", "UG", "UK", "UR", "UZ", "VI", "VO", "CY", "WO", "XH", "YI", "YO", "ZA", "ZU" - `report.companySummary` (object) - `report.companySummary.businessName` (string) Registered company name/trading name of the business. - `report.companySummary.country` (string) Country where the company is registered. Enum: "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "XK", "SS", "SX", "CW", "BQ", "WW", "PLC" - `report.companySummary.companyNumber` (string) Creditsafe global identifier, called the Safe Number. - `report.companySummary.companyRegistrationNumber` (string) Official registration number. - `report.companySummary.ggsID` (string) The Connect API ID as used in v1.3 (GGS). - `report.companySummary.leiNumber` (string) Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation - `report.companySummary.mainActivity` (object) Main activity classification being used for the company’s main activity, including the code, industry sector, and description. - `report.companySummary.mainActivity.code` (string) Main activity code used in that country e.g. SIC / NACE. - `report.companySummary.mainActivity.industrySector` (string) (Optionally populated) A high-level description, describing the industry sector/division in which the company operates. - `report.companySummary.mainActivity.description` (string) Description of main activity. - `report.companySummary.mainActivity.classification` (string) The type of activity classification being used for the main activity. E.g SIC07, NACE Rev2 etc. Where possible includes the version/revision date. - `report.companySummary.companyStatus` (object) High-level status of the company, such as 'Active', 'NonActive', 'Pending', or 'Other'. - `report.companySummary.companyStatus.status` (string) High-level status. Values include "Active", "NonActive", "Pending" and "Other". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status. Enum: "Active", "NonActive", "Pending", "Other" - `report.companySummary.companyStatus.providerStatus` (string) (Optionally populated) high-level local status. E.g. may contain a registry status, such as "Active" for a "Non-Trading" company, whereas the common "status" will say “NonActive". - `report.companySummary.companyStatus.providerCode` (string) (Optionally populated) if available, this code pairs with the companyStatus.description - `report.companySummary.companyStatus.isActive` (boolean) Boolean [true/false] when set to true indicates that the company is economically active. - `report.companySummary.companyStatus.description` (string) A more in-depth status value, based on local descriptions. - `report.companySummary.latestTurnoverFigure` (object) - `report.companySummary.latestTurnoverFigure.currency` (string) The Currency in which the financial value is displayed, as a three-character ISO code. Enum: "AFA", "ALL", "DZD", "ADF", "ADP", "AOA", "ARA", "ARS", "AMD", "AWG", "AUD", "AZM", "BSD", "BHD", "BDT", "BBD", "BYR", "BZD", "BMD", "BTN", "BOB", "BAM", "BWP", "BRC", "BRL", "GBP", "BND", "BGN", "BIF", "XOF", "XAF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CUP", "CZK", "DKK", "DJF", "DOP", "NLG", "EUR", "ECS", "EGP", "SVC", "EEK", "ETB", "FKP", "FJD", "FRF", "GMD", "GEL", "GHC", "GIP", "XAU", "GTQ", "GNF", "GWP", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KRW", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MOP", "MKD", "MGF", "MWK", "MYR", "MVR", "MTL", "MRO", "MUR", "MXN", "MDL", "MNT", "MAD", "MZM", "MMK", "ANG", "NAD", "NPR", "NZD", "NIO", "NGN", "KPW", "NOK", "OMR", "PKR", "XPD", "PAB", "PGK", "PYG", "PEN", "PHP", "XPT", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "XAG", "SGD", "SKK", "SIT", "SBD", "SOS", "ZAR", "LKR", "SHP", "SDD", "SDG", "SDP", "SRD", "SRG", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMM", "USD", "UGX", "UAG", "UAK", "AED", "UYU", "UZS", "VUV", "VEF", "VND", "YUN", "ZMK", "ZWD", "AFN", "ATS", "AZN", "BYN", "BEF", "BOV", "GRD", "FIM", "DEM", "GHS", "IEP", "ITL", "LUF", "PTE", "ESP", "XDR", "TMT", "UAH", "ERN", "MGA", "MRU", "MZN", "SSP", "STN", "YER", "XPF", "XCD", "ZMW", "ZWL" - `report.companySummary.latestTurnoverFigure.value` (number) The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders. - `report.companySummary.latestShareholdersEquityFigure` (object) - `report.companySummary.creditRating` (object) - `report.companySummary.creditRating.commonValue` (string) Standardised credit score – will be A, B, C, D or E. Enum: "A", "B", "C", "D", "E" - `report.companySummary.creditRating.commonDescription` (string) A text description of the common credit score. - `report.companySummary.creditRating.creditLimit` (object) - `report.companySummary.creditRating.creditLimit.value` (string) Amount of credit advisable at any one time. - `report.companySummary.creditRating.providerValue` (object) - `report.companySummary.creditRating.providerValue.maxValue` (string) The maximum value of the score that is provided for the Country. - `report.companySummary.creditRating.providerValue.minValue` (string) The minimum value of the score that is provided for the Country. - `report.companySummary.creditRating.providerValue.value` (string) Local credit score, as used by the supplier in that particular country - `report.companySummary.creditRating.providerDescription` (string) Local credit score description. - `report.companySummary.creditRating.pod` (number,null) Probability of Default (POD) is the anticipated likelihood of company default within the next 12 months in a percentage format. - `report.companySummary.creditRating.assessment` (string) An additional score assessment commentary. - `report.companyIdentification` (object) - `report.companyIdentification.basicInformation` (object) - `report.companyIdentification.basicInformation.businessName` (string,null) The trading name of business, or “-“ if unknown - `report.companyIdentification.basicInformation.registeredCompanyName` (string) Registered company name, the legal name of the company. For NonLtd companies this would include the Owner name (i.e. the legal name), or “-“ if unknown. - `report.companyIdentification.basicInformation.ggsId` (string) The Connect API ID as used in v1.3 (GGS). - `report.companyIdentification.basicInformation.leiNumber` (string) Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation. - `report.companyIdentification.basicInformation.vatRegistrationNumber` (string) Local VAT Number. - `report.companyIdentification.basicInformation.vatRegistrationDate` (string,null) Registration date of the local VAT number. - `report.companyIdentification.basicInformation.companyRegistrationDate` (string,null) The date the company was registered. - `report.companyIdentification.basicInformation.operationsStartDate` (string,null) The date the company began trading. - `report.companyIdentification.basicInformation.commercialCourt` (string) The local commercial court at which the company was registered. - `report.companyIdentification.basicInformation.legalForm` (object) - `report.companyIdentification.basicInformation.legalForm.commonCode` (string) A common global code that aims to categorise legal forms across Countries. Currently only available for Non Ltd reports as “Sole Trader” or “Other”. - `report.companyIdentification.basicInformation.legalForm.providerCode` (string) The local provider legal form codes specific to each Country - `report.companyIdentification.basicInformation.legalForm.description` (string) The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc. - `report.companyIdentification.basicInformation.officeType` (any) Describes the office establishment type Enum: "Registered", "Trading", "HeadOffice", "Branch", "Subsidiary", "Franchise", "Franchisor", "SingleOffice" - `report.companyIdentification.basicInformation.ownershipType` (string) Whether the company is wholly, part owned etc. - `report.companyIdentification.basicInformation.principalActivity` (object) Main activity classification being used for the company’s main activity, including the code, industry sector, and description. - `report.companyIdentification.basicInformation.contactAddress` (object) - `report.companyIdentification.basicInformation.contactAddress.type` (string) Address type description. Examples - "Registered Office", "Trading Address", "Postal Address", "Service Address" etc. - `report.companyIdentification.basicInformation.contactAddress.simpleValue` (string) (Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed. - `report.companyIdentification.basicInformation.contactAddress.street` (string) Street portion of the address line. Can also, optionally contain, the house number alongside the street. - `report.companyIdentification.basicInformation.contactAddress.houseNumber` (string) House number portion of the address line. - `report.companyIdentification.basicInformation.contactAddress.additionToAddress` (string) Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location. - `report.companyIdentification.basicInformation.contactAddress.city` (string) City portion of the address line. - `report.companyIdentification.basicInformation.contactAddress.postalCode` (string) Postal code portion of the address line. - `report.companyIdentification.basicInformation.contactAddress.province` (string) Province portion of the address line. - `report.companyIdentification.basicInformation.contactAddress.region` (string) May contain the geographical region, for example "South-East" or a territorial division. - `report.companyIdentification.basicInformation.contactAddress.telephone` (string) Registered telephone number. - `report.companyIdentification.basicInformation.contactAddress.directMarketingOptOut` (boolean,null) Boolean [true/false]. Where set to true, the subject has "opted out" via a central register, and they must not be contacted for commercial marketing purposes. - `report.companyIdentification.basicInformation.contactAddress.directMarketingOptIn` (boolean,null) - `report.companyIdentification.activityClassifications` (array) - `report.companyIdentification.activityClassifications.classification` (string) The type of activity classification being used in the activities array. E.g. SIC07, NACE etc. Where possible includes the version/revision date. - `report.companyIdentification.activityClassifications.activities` (array) - `report.companyIdentification.activityClassifications.activities.code` (string) Industry code used in that country e.g. SIC / NACE - `report.companyIdentification.activityClassifications.activities.description` (string) Description of company’s main activity. - `report.companyIdentification.previousNames` (array) - `report.companyIdentification.previousNames.dateChanged` (string,null) Date when this name was officially changed (i.e. end date). - `report.companyIdentification.previousNames.name` (string) Any previous name under which the company was registered. - `report.companyIdentification.previousLegalForms` (array) - `report.creditScore` (object) - `report.creditScore.currentCreditRating` (object) - `report.creditScore.currentContractLimit` (object) - `report.creditScore.previousCreditRating` (object) - `report.creditScore.latestRatingChangeDate` (string,null) Last date that the credit score changed. - `report.contactInformation` (object) - `report.contactInformation.mainAddress` (object) - `report.contactInformation.mainAddress.postalCode` (string) Postal code portion of the address line - `report.contactInformation.mainAddress.telephone` (string) Telephone number of the main address. - `report.contactInformation.otherAddresses` (array) - `report.contactInformation.previousAddresses` (array) - `report.contactInformation.emailAddresses` (array) Email address for the company. - `report.contactInformation.websites` (array) Website address of the company. - `report.indicators` (array) Indicators provides additional information when assessing a company's performance. This is a premium service, not available for all customers. - `report.indicators.type` (string) A lowercase char(3) code indicating the type of indicator. For example - Financial Strength Indicator (“fsi”), Payment Behaviour Indicator (“pbi”), Payment Expectation Indicator (“pei”). Enum: "eti", "pei", "fsi", "pbi" - `report.indicators.value` (string) The value of the indicator. Example: "X" - `report.indicators.changeDate` (string) The date associated with the current indicator. - `report.indicators.industryComparison` (object) - `report.indicators.industryComparison.sectorCode` (string) - `report.indicators.industryComparison.sectorAverage` (string) The average indicator value for the industry sector in which the subject company operates. - `report.indicators.industryComparison.sectorCount` (integer,null) The count of all companies in this industry sector. - `report.indicators.industryComparison.totalAverage` (string) The average indicator value for all companies (irrespective of industry sector). - `report.indicators.industryComparison.totalCount` (integer,null) The count of all companies (irrespective of industry sector). - `report.shareCapitalStructure` (object) - `report.shareCapitalStructure.nominalShareCapital` (object) - `report.shareCapitalStructure.issuedShareCapital` (object) - `report.shareCapitalStructure.shareCapitalCurrency` (string) The Currency in which the share values are displayed, as a three-character ISO code. - `report.shareCapitalStructure.numberOfSharesIssued` (integer,null) The total number of issued shares. - `report.shareCapitalStructure.shareHolders` (array) - `report.shareCapitalStructure.shareHolders.id` (string) Unique ID. - `report.shareCapitalStructure.shareHolders.idType` (string) Description for the ID, to describe the type of ID presented e.g. Person number, Tax ID (if a company), Company Registration Number etc. Enum: "Other", "SafeNumber", "RegistrationNumber", "VATNumber", "TaxID", "PersonNumber", "ExternalID", "InternalID" - `report.shareCapitalStructure.shareHolders.name` (string) Name of the Shareholder, or Company Name if a corporate shareholder exists. - `report.shareCapitalStructure.shareHolders.title` (string) Title, if known. - `report.shareCapitalStructure.shareHolders.firstNames` (string) First name(s) of the shareholder. May optionally include middle names, or initials if these cannot be distinguished. - `report.shareCapitalStructure.shareHolders.firstName` (string) First name of the shareholder. This field should be used if a middleName also exists. - `report.shareCapitalStructure.shareHolders.middleName` (string) Middle name of the shareholder. - `report.shareCapitalStructure.shareHolders.surname` (string) Last name of the shareholder. - `report.shareCapitalStructure.shareHolders.address` (object) - `report.shareCapitalStructure.shareHolders.shareholderType` (string) Indicates if the shareholders record relates to a "Person", "Company" or "Other". Enum: "Other", "Person", "Company" - `report.shareCapitalStructure.shareHolders.shareType` (string) The share class, for example "Ordinary". - `report.shareCapitalStructure.shareHolders.totalValueOfSharesOwned` (number,null) The total nominal value of all shares owned. Expressed as an integer, or to two decimal places. - `report.shareCapitalStructure.shareHolders.totalNumberOfSharesOwned` (integer,null) The total number of all shares owned. - `report.shareCapitalStructure.shareHolders.percentSharesHeld` (number,null) The total percentage of all shares held. Expressed as an integer, or to two decimal places. - `report.shareCapitalStructure.shareHolders.startDate` (string,null) Date when the shareholding started. - `report.shareCapitalStructure.shareHolders.endDate` (string,null) Date when the shareholding ended. Where populated, this indicates that the party has ceased to be a shareholder. - `report.shareCapitalStructure.shareHolders.hasNegativeInfo` (boolean,null) Boolean [true/false] when set to true, this indicates that the shareholder has negative information such as Protesti, Court Judgements etc. linked to their unique shareholders ID. - `report.shareCapitalStructure.shareHolders.shareClasses` (array) - `report.shareCapitalStructure.shareHolders.shareClasses.shareType` (string) (Optionally populated) The share class description. - `report.shareCapitalStructure.shareHolders.shareClasses.valuePerShare` (number,null) (Optionally populated) The value per share, also known as the par value. Expressed as an integer, or to two decimal places. - `report.shareCapitalStructure.shareHolders.shareClasses.jointlyOwned` (boolean,null) (Optionally populated) Boolean. Set to true where the shares are jointly owned. - `report.shareCapitalStructure.shareHolders.shareClasses.numberOfSharesOwned` (integer,null) (Optionally populated) The number of shares owned. If more than one share class exists, this is the number per share class. - `report.shareCapitalStructure.shareHolders.shareClasses.valueOfSharesOwned` (number,null) (Optionally populated) The total nominal value of Shares owned. If more than one share class exists, this is the total nominal value per share class. - `report.shareCapitalStructure.shareHolders.shareClasses.additionalData` (object) A free-flowing section, containing country specific elements. - `report.directors` (object) - `report.directors.currentDirectors` (array) - `report.directors.currentDirectors.gender` (string) Enum: "Unknown", "Male", "Female", "NotApplicable" - `report.directors.currentDirectors.birthName` (string) The birth name or previous legal name of the officer. - `report.directors.currentDirectors.dateOfBirth` (string,null) The director’s date of birth. - `report.directors.currentDirectors.placeOfBirth` (string) The director’s place or region of birth. - `report.directors.currentDirectors.nationality` (string) The director’s nationality or country of birth. - `report.directors.currentDirectors.countryOfResidence` (string) The country of residence, if known. - `report.directors.currentDirectors.directorType` (string) Indicates if the shareholders record relates to a "Person", "Company" or "Other". Enum: "Other", "Person", "Company" - `report.directors.currentDirectors.hasNegativeInfo` (boolean,null) Linked with DE searches, may return with other countries if data is available. Boolean [true/false] if the director has negative information, such as Protesti, Court Judgements etc linked to their unique directors ID. Boolean [true/false] set to true where the director is known to be an authorised signatory. Further details, if known, may be present in "authority" or "additionalData". - `report.directors.currentDirectors.signingAuthority` (boolean,null) Linked with DE searches, may return with other countries if data is available. - `report.directors.currentDirectors.positions` (array) - `report.directors.currentDirectors.positions.dateAppointed` (string,null) The date the director was appointed. - `report.directors.currentDirectors.positions.commonCode` (string) A common global code that aims to categorise director positions across Countries – currently no data available. - `report.directors.currentDirectors.positions.providerCode` (string) The local provider director code (if exists) specific to each Country. - `report.directors.currentDirectors.positions.positionName` (string) The director’s role/position in a company. - `report.directors.currentDirectors.positions.authority` (string) If available, any available details pertaining to the score, power, limitations, signing authority or ability to bind the company. - `report.directors.currentDirectors.positions.apptDurationType` (string) The appointment duration should be used in conjunction with the appointment term field. - `report.directors.previousDirectors` (array) - `report.directors.previousDirectors.resignationDate` (string,null) The date the director resigned. - `report.directorships` (object) - `report.directorships.currentDirectorships` (array) - `report.directorships.currentDirectorships.id` (string) - `report.directorships.currentDirectorships.title` (string) - `report.directorships.currentDirectorships.initials` (string) - `report.directorships.currentDirectorships.name` (string) - `report.directorships.currentDirectorships.position` (object) - `report.directorships.currentDirectorships.position.resignationDate` (string,null) - `report.directorships.currentDirectorships.registrationNumber` (string) - `report.directorships.currentDirectorships.companyName` (string) - `report.directorships.currentDirectorships.status` (object) High-level status of the company, such as 'Active', 'NonActive', 'Pending', or 'Other'. - `report.directorships.previousDirectorships` (array) - `report.otherInformation` (object) - `report.otherInformation.bankers` (array) - `report.otherInformation.bankers.name` (string) Name of bank that the company holds an account with. - `report.otherInformation.bankers.bankCode` (string) Bank code associated with the bank. - `report.otherInformation.bankers.bic` (string) Bank Identifier Code (BIC) or SWIFT code, used for international transfers. - `report.otherInformation.advisors` (array) - `report.otherInformation.advisors.auditorName` (string) Full name of the company who is responsible for auditing. - `report.otherInformation.advisors.solicitorName` (string) Name of solicitors. - `report.otherInformation.advisors.accountantName` (string) Full name of the accountancy firm who responsible for preparing the accounts. - `report.otherInformation.employeesInformation` (array) - `report.otherInformation.employeesInformation.year` (integer,null) Year that the figures were reordered. - `report.otherInformation.employeesInformation.numberOfEmployees` (string) Number of staff that the company employ directly. - `report.groupStructure` (object) - `report.groupStructure.ultimateParent` (object) - `report.groupStructure.ultimateParent.id` (string) Connect Id. - `report.groupStructure.ultimateParent.registrationNumber` (string) Official registration number. - `report.groupStructure.ultimateParent.safeNo` (string) Creditsafe global identifier, called the Safe Number. - `report.groupStructure.ultimateParent.name` (string) Full company name of Ultimate Holding Company. - `report.groupStructure.ultimateParent.type` (string) is only available for countries in Norway. Enum: "NotSet", "Ltd", "NonLtd", "NonLtdNonReg" - `report.groupStructure.ultimateParent.officeType` (string) Enum: "registered", "trading", "headOffice", "branch", "subsidiary", "franchise", "franchisor", "singleOffice", "other" - `report.groupStructure.ultimateParent.vatNo` (any) Local VAT Number. - `report.groupStructure.ultimateParent.additionalInformation` (object) - `report.groupStructure.ultimateParent.additionalInformation.isPLC` (string) - `report.groupStructure.ultimateParent.additionalInformation.coefficientLinear` (number) - `report.groupStructure.ultimateParent.activity` (object) Main activity classification being used for the company’s main activity, including the code, industry sector, and description. - `report.groupStructure.immediateParent` (object) - `report.groupStructure.subsidiaryCompanies` (array) - `report.groupStructure.affiliatedCompanies` (array) - `report.extendedGroupStructure` (array) - `report.extendedGroupStructure.country` (string) Country where the company is established. - `report.extendedGroupStructure.safeNumber` (string) Creditsafe global identifier, called the Safe Number. - `report.extendedGroupStructure.companyName` (string) Full company name. - `report.extendedGroupStructure.registeredNumber` (string) Official registration number. - `report.extendedGroupStructure.latestAnnualAccounts` (string,null) The last filed financial statements Year End Date of the company. - `report.extendedGroupStructure.level` (integer) The hierarchical level of the company within the group structure. - `report.extendedGroupStructure.percentOfOwnership` (number,null) The percentage of shares owned. - `report.extendedGroupStructure.status` (string) High-level status. Values include "Active", "NonActive", "Pending" and "Other". - `report.extendedGroupStructure.commonRatingBand` (string) Standardised credit score. - `report.financialStatements` (array) - `report.financialStatements.type` (string) A code element set as "GlobalFinancialsGGS", which represents that the financial statements are in a common/standardised international format. - `report.financialStatements.yearEndDate` (string) Financial Year End date for the annual accounts. - `report.financialStatements.numberOfWeeks` (integer,null) Number of weeks in the year. - `report.financialStatements.consolidatedAccounts` (boolean,null) Boolean [true/false]. Are the accounts consolidated? - `report.financialStatements.profitAndLoss` (object) - `report.financialStatements.profitAndLoss.revenue` (number,null) Income earned from normal business activities, including the sale of goods and services. - `report.financialStatements.profitAndLoss.operatingCosts` (number,null) Costs incurred in the general running of the business. - `report.financialStatements.profitAndLoss.operatingProfit` (number,null) The results of the company after deducting Operating Costs from its Revenue. - `report.financialStatements.profitAndLoss.wagesAndSalaries` (number,null) Wages and salaries paid to employees of the company. Where possible this excludes Pensions. - `report.financialStatements.profitAndLoss.pensionCosts` (number,null) The cost of pension benefits for employees of the company. - `report.financialStatements.profitAndLoss.depreciation` (number,null) The amount written off Tangible Fixed Assets during the year. - `report.financialStatements.profitAndLoss.amortisation` (number,null) The amount written off Intangible Fixed Assets during the year. - `report.financialStatements.profitAndLoss.financialIncome` (number,null) Interest income earned during the year. - `report.financialStatements.profitAndLoss.financialExpenses` (number,null) Interest expenses incurred during the year. - `report.financialStatements.profitAndLoss.extraordinaryIncome` (number,null) Income arising due to events of a non-recurring nature. - `report.financialStatements.profitAndLoss.extraordinaryCosts` (number,null) Costs incurred due to events of a non-recurring nature. - `report.financialStatements.profitAndLoss.profitBeforeTax` (number,null) The results of the company before deducting any charge for taxation. - `report.financialStatements.profitAndLoss.tax` (number,null) Taxation payable on the profits of the company. - `report.financialStatements.profitAndLoss.profitAfterTax` (number,null) The results of the company after deducting any charge for taxation. - `report.financialStatements.profitAndLoss.dividends` (number,null) The total amount of profits distributed to shareholders. - `report.financialStatements.profitAndLoss.minorityInterests` (number,null) Profits attributable to shareholders holding a minority interest in the company. - `report.financialStatements.profitAndLoss.otherAppropriations` (number,null) Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company. - `report.financialStatements.profitAndLoss.retainedProfit` (number,null) The results of the company after all income and expenses have been credited/debited. - `report.financialStatements.balanceSheet` (object) - `report.financialStatements.balanceSheet.landAndBuildings` (number,null) Land and buildings owned by the company for long-term use. - `report.financialStatements.balanceSheet.plantAndMachinery` (number,null) Plant and machinery owned by the company for long-term use. - `report.financialStatements.balanceSheet.otherTangibleAssets` (number,null) Tangible fixed assets other than Land & Buildings or Plant & Machinery. - `report.financialStatements.balanceSheet.totalTangibleAssets` (number,null) Physical assets owned by the company for long-term use. - `report.financialStatements.balanceSheet.goodwill` (number,null) The premium paid or accumulated on the purchase of an asset. - `report.financialStatements.balanceSheet.otherIntangibleAssets` (number,null) Intangible fixed assets other than goodwill such as Trademarks, Patents, Research & Development, etc. - `report.financialStatements.balanceSheet.totalIntangibleAssets` (number,null) Assets that have a value but no physical existence. - `report.financialStatements.balanceSheet.investments` (number,null) Long-term investments including shares and securities. - `report.financialStatements.balanceSheet.loansToGroup` (number,null) Long-term loans made by the company to related businesses. - `report.financialStatements.balanceSheet.otherLoans` (number,null) Other long-term loans made by the company. - `report.financialStatements.balanceSheet.miscellaneousFixedAssets` (number,null) Long-term assets other than Tangible Assets, Intangible Assets, Investments, or Loans. - `report.financialStatements.balanceSheet.totalOtherFixedAssets` (number,null) Total long-term assets other than Tangible Assets or Intangible Assets. - `report.financialStatements.balanceSheet.totalFixedAssets` (number,null) The total of Tangible, Intangible, and Other Fixed Assets. - `report.financialStatements.balanceSheet.rawMaterials` (number,null) Materials held by the company that have not yet been processed. - `report.financialStatements.balanceSheet.workInProgress` (number,null) Goods or contracts that are in the process of manufacture or completion. - `report.financialStatements.balanceSheet.finishedGoods` (number,null) Goods held that are ready for sale or use. - `report.financialStatements.balanceSheet.otherInventories` (number,null) Other amounts classed as Inventory but not included above. - `report.financialStatements.balanceSheet.totalInventories` (number,null) The total of stocks held by the company and work in progress. - `report.financialStatements.balanceSheet.tradeReceivables` (number,null) Amounts due within one year from customers for goods and services supplied on credit. - `report.financialStatements.balanceSheet.groupReceivables` (number,null) Amounts due within one year from related businesses. - `report.financialStatements.balanceSheet.receivablesDueAfter1Year` (number,null) Amounts due after one year owing to the company (including trade and group receivables due after one year). - `report.financialStatements.balanceSheet.miscellaneousReceivables` (number,null) Amounts due within one year owing to the company other than trade and group receivables. - `report.financialStatements.balanceSheet.totalReceivables` (number,null) Total amounts receivable by the company. - `report.financialStatements.balanceSheet.cash` (number,null) Cash at bank, cash in hand, and cash equivalents. - `report.financialStatements.balanceSheet.otherCurrentAssets` (number,null) Any short-term assets that have not already been included as Inventory, Receivables, or Cash. - `report.financialStatements.balanceSheet.totalCurrentAssets` (number,null) The total of Stocks, Debtors, Cash, and other assets due within one year. - `report.financialStatements.balanceSheet.totalAssets` (number,null) The total of Current and Fixed Assets. - `report.financialStatements.balanceSheet.tradePayables` (number,null) Amounts due within one year owing to suppliers for goods and services provided on credit. - `report.financialStatements.balanceSheet.bankLiabilities` (number,null) Amounts due within one year owing to banks for overdrafts and loans. - `report.financialStatements.balanceSheet.otherLoansOrFinance` (number,null) Loans or finance due within one year owing to parties other than banks or related businesses. - `report.financialStatements.balanceSheet.groupPayables` (number,null) Amounts due within one year to related businesses. - `report.financialStatements.balanceSheet.miscellaneousLiabilities` (number,null) Other amounts due within one year owing by the company. - `report.financialStatements.balanceSheet.totalCurrentLiabilities` (number,null) Total short-term liabilities of the company. - `report.financialStatements.balanceSheet.tradePayablesDueAfter1Year` (number,null) Amounts due after one year owing to suppliers for goods and services provided on credit. - `report.financialStatements.balanceSheet.bankLiabilitiesDueAfter1Year` (number,null) Amounts due after one year owing to banks for overdrafts and loans. - `report.financialStatements.balanceSheet.otherLoansOrFinanceDueAfter1Year` (number,null) Loans or finance due after one year owing to parties other than banks or related businesses. - `report.financialStatements.balanceSheet.groupPayablesDueAfter1Year` (number,null) Amounts due after one year to related businesses. - `report.financialStatements.balanceSheet.miscellaneousLiabilitiesDueAfter1Year` (number,null) Other amounts due after one year owing by the company. - `report.financialStatements.balanceSheet.totalLongTermLiabilities` (number,null) Total long-term liabilities of the company. - `report.financialStatements.balanceSheet.totalLiabilities` (number,null) The total of Total Long-term Liabilities and Total Current Liabilities. - `report.financialStatements.balanceSheet.calledUpShareCapital` (number,null) The issued and paid share capital from shareholders. - `report.financialStatements.balanceSheet.sharePremium` (number,null) The excess of the amount received on the issue of shares over their value. - `report.financialStatements.balanceSheet.revenueReserves` (number,null) The accumulation of profits/losses from previous trading periods. - `report.financialStatements.balanceSheet.otherReserves` (number,null) Other capital and reserves that form part of shareholders' equity. - `report.financialStatements.balanceSheet.totalShareholdersEquity` (number,null) The total capital and reserves of the company. - `report.financialStatements.otherFinancials` (object) - `report.financialStatements.otherFinancials.contingentLiabilities` (string) 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”). - `report.financialStatements.otherFinancials.workingCapital` (number,null) 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. - `report.financialStatements.otherFinancials.netWorth` (number,null) Often referred to as the 'book value' of the business this equals Total Shareholders’ Equity less Total Intangible Assets - `report.financialStatements.ratios` (object) - `report.financialStatements.ratios.preTaxProfitMargin` (number,null) Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the equivalent of retailers 'mark-up'. - `report.financialStatements.ratios.returnOnCapitalEmployed` (number,null) Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return for the money (Capital) invested. - `report.financialStatements.ratios.returnOnTotalAssetsEmployed` (number,null) Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or 'profit' on each pound of Assets used as a percentage. - `report.financialStatements.ratios.returnOnNetAssetsEmployed` (number,null) 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. - `report.financialStatements.ratios.salesOrNetWorkingCapital` (number,null) 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. - `report.financialStatements.ratios.stockTurnoverRatio` (number,null) 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. - `report.financialStatements.ratios.debtorDays` (number,null) 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. - `report.financialStatements.ratios.creditorDays` (number,null) 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. - `report.financialStatements.ratios.currentRatio` (number,null) 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. - `report.financialStatements.ratios.liquidityRatioOrAcidTest` (number,null) 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. - `report.financialStatements.ratios.currentDebtRatio` (number,null) Total Current Liabilities / Total Shareholders’ Equity. This measures the amount of short-term debt in relation to the value of shareholders’ funds. - `report.financialStatements.ratios.gearing` (number,null) 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). - `report.financialStatements.ratios.equityInPercentage` (number,null) 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. - `report.financialStatements.ratios.totalDebtRatio` (number,null) 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. - `report.localFinancialStatements` (array) - `report.localFinancialStatements.profitAndLoss` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.localFinancialStatements.balanceSheet` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.localFinancialStatements.otherFinancials` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.localFinancialStatements.ratios` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.negativeInformation` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.additionalInformation` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.directorsExtra` (object) - `report.extendedGroupStructureExtra` (object) - `report.paymentData` (object) Please refer to the relevant country data dictionary for the properties expected in this object HERE - `report.paymentDataExtra` (object) - `report.alternateSummary` (object) - `report.negativeInformationExtra` (object) - `report.exceptions` (array) Identifies unusual behaviours, for example multiple changes in address in a short period of time. This is a premium service, not available for all customers and is only availble for specific report templates [gycs, custom, full]. - `report.exceptions.eventType` (object) Describes the exception alert - `report.exceptions.eventType.code` (string) A code associated with the exception event, for example GA_8 - `report.exceptions.eventType.description` (string) A description associated with the event, for example "Multiple companies has this exact address". - `report.exceptions.eventLevel` (object) Level of risk for the exception alert - `report.exceptions.eventLevel.code` (string) A numeric code which indicates if the event level is General [0] OR "High" [1]. - `report.exceptions.eventLevel.description` (string) A text description which indicates if the event level is General [0] OR "High" [1]. - `report.exceptions.eventDate` (string) The date associated with the exception event - this might be the date when the unusual behaviour was detected, not necessarily the date of the original event. - `dateOfOrder` (string) - `userId` (integer) ## Response 400 fields (application/json): - `correlationId` (string) A unique ID assigned to this request. - `message` (string) - `details` (string) Provides further information on why the request was rejected ## Response 401 fields (application/json): - `error` (string) ## Response 403 fields (application/json): - `message` (string) Example: "Access forbidden" ## Response 404 fields (application/json): - `correlationId` (string) A unique ID assigned to this request. - `message` (string) - `details` (string) Provides further information on why the request was rejected