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-12345678

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"

Example:language=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"

Example:template=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

Example:includeIndicators=true

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.

Example:customData=de_reason_code::1

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

Example:callRef=my-reference-123

Acceptstring

The format of the report. application/json (the default) returns the JSON report. application/pdf returns the report as a PDF file, and application/html as an HTML page. application/json+pdf and application/json+html return the JSON report with the PDF (pdfReportStream) or HTML (htmlReportStream) as base64. application/pdf+html returns the PDF only.

Default:"application/json"

Enum:"application/json""application/pdf""application/html""application/pdf+html""application/json+pdf""application/json+html"

Example:application/json

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies/GB-0-12345678?language=en&template=full&includeIndicators=true&customData=de_reason_code%3A%3A1&callRef=my-reference-123' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns the company report in the format requested in the Accept header. The sections and fields returned depend on the country, the template and your access.

Body

correlationIdstring

A unique ID assigned to this request.

Example:"64e76e77-096a-4f21-881b-613f13070c78"

failedSectionsArray of strings(CreditsafeGlobalDataReportsReportSection)

Report sections that couldn't be returned.

Items Enum:"CompanySummary""CompanySummaryExtra""AlternateSummary""CompanyIdentification""CompanyIdentificationExtra""CreditScore""CreditScoreExtra""ContactInformation""ContactInformationExtra""ShareCapitalStructure"

reportobject(CreditsafeGlobalDataReportsCompanyReport)

The company report.

companyIdstring

The Connect id of the company the report is for.

Example:"GB-0-12345678"

dateOfOrderstring, (date-time)

The date and time the report was ordered.

Example:"2026-11-06T15:56:57.714Z"

languagestring

The language of the report, as requested in the language parameter.

Example:"en"

userIdstring

The id of the user who ordered the report.

Example:"100000001"

Response

{
  "correlationId": "64e76e77-096a-4f21-881b-613f13070c78",
  "report": {
    "companyId": "GB-0-12345678",
    "language": "EN",
    "companySummary": { … },
    "companyIdentification": { … },
    "creditScore": { … },
    "contactInformation": { … },
    "shareCapitalStructure": { … },
    "directors": { … },
    "otherInformation": { … },
    "groupStructure": { … },
    "extendedGroupStructure": [ … ],
    "financialStatements": [ … ],
    "paymentData": { … },
    "negativeInformation": { … }
  },
  "companyId": "GB-0-12345678",
  "dateOfOrder": "2026-11-06T15:56:57.714Z",
  "language": "en",
  "userId": "100000001"
}