Skip to content
Connect API Catalog/
/
/
Company Credit Report

Company Credit Report

Request

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.

The response properties listed for this endpoint represent the core global company fields. For country-specific fields and a complete list of all possible properties for a given country, use the Report Schema endpoint. Not all properties will be returned in every response—fields with no value are omitted by design.

In OpenAPI, properties not listed as required are optional.

Refer to the Companies help documentation.

Security
bearerToken
Path
connectIdstringrequired

The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from /companies search results.

Example:GB-0-03836192
Query
languagestring or null^[a-zA-Z]{2}$

Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

Default:"en"
templatestring or 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 glossary and availability

Default:"full"
includeIndicatorsboolean

Optional parameter to include the indicator scores in to a company report -fsi = Financial Strength , pbi = Payment Behaviour Indicator, eti = Estimated Turnover, pei = Payment Expectation Indicator

Addition information on indicator acronyms can be found report indicator definitions

Addition information on understanding indicators can be found indicator guidance in the Scores and Indicators tab

Default:false
customDatastring or null

Additional Report Parameters e.g. German Report Reason Code value is de_reason_code::1 . Use /reportcustomdata/{country} endpoint to see all values.

callRefstring or 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.

Default:null
Headers
AcceptPDF (string) or HTML (string) or PDF + HTML (string) or JSON + PDF (string) or JSON + HTML (string)
Example:application/pdf
One of:

Specifies the desired response format.

string(PDF)
Value:"application/pdf"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies/GB-0-03836192?language=en&template=full&includeIndicators=false&customData=string&callRef=%7BcallRef%7D' \
  -H 'Accept: application/pdf' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Body
correlationIdstring

A unique ID assigned to this request.

failedSectionsArray of strings(CreditsafeGlobalDataReportsReportSection)
Items Enum:"CompanySummary""CompanySummaryExtra""AlternateSummary""CompanyIdentification""CompanyIdentificationExtra""CreditScore""CreditScoreExtra""ContactInformation""ContactInformationExtra""ShareCapitalStructure"
reportobject(CreditsafeGlobalDataReportsCompanyReport)
companyIdstring
dateOfOrderstring, (date-time)
languagestring
userIdinteger
Response
{
  "correlationId": "string",
  "failedSections": [
    "CompanySummary"
  ],
  "report": {
    "companyId": "string",
    "language": "OM",
    "companySummary": { … },
    "companyIdentification": { … },
    "creditScore": { … },
    "contactInformation": { … },
    "indicators": [ … ],
    "shareCapitalStructure": { … },
    "directors": { … },
    "directorships": { … },
    "otherInformation": { … },
    "groupStructure": { … },
    "extendedGroupStructure": [ … ],
    "financialStatements": [ … ],
    "localFinancialStatements": [ … ],
    "negativeInformation": {},
    "additionalInformation": {},
    "directorsExtra": {},
    "extendedGroupStructureExtra": {},
    "paymentData": {},
    "paymentDataExtra": {},
    "alternateSummary": {},
    "negativeInformationExtra": {},
    "exceptions": [ … ]
  },
  "companyId": "string",
  "dateOfOrder": "2019-08-24T14:15:22Z",
  "language": "string",
  "userId": 0
}