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.

SecuritybearerToken
Request
path Parameters
connectId
required
string

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 Parameters
language
string or null^[a-zA-Z]{2}$
Default: "en"

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

template
string or null
Default: "full"

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
Default: false

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 HERE.

Addition information on understanding indicators can be found HERE.

customData
string 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.

callRef
string or null
Default: 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.

header Parameters
Accept
string

Applies request for PDF link to Company Report.

Example: application/json+pdf
Responses
200
400
401
get/companies/{connectId}
Request samples 
Response samples 
{
  • "correlationId": "string",
  • "failedSections": [
    ],
  • "report": {
    },
  • "companyId": "string",
  • "dateOfOrder": "2019-08-24T14:15:22Z",
  • "language": "string",
  • "userId": 0
}
➔ Next to Confidence Match Search