Templates allow you to order specific parts of the Company Credit Report, avoiding the need to order the full report object in one API call.
This can be particularly useful in situations where:
- You want to minimize the average response time/size of the response
- You only want to receive certain data points.
- Your integration requires different datasets under different scenarios - i.e - you want to capture an overview of the company initially and only order further enhanced data points under specific criteria (order an overview, then financials and negative information).
Each template has its own charging service line that you need access to order.
Template Glossary
Name | Parameter | Description | Remarks |
---|---|---|---|
Full | {null} | Default Full Report | Contains all other templates by definition. |
Company Summary | summary | An overview of the company containing Company Name + Registration Number Primary Activity Code Status Latest Turnover Figure Latest Shareholder Equity Figure Credit Score (local + international) | Report section: companySummary |
Basic | basic | Basic contact information on the company - index data and identifiers. Company Name + Registration Number Previous Names Status Contact Addresses / Other Addresses Activity Codes Website Number of Employees No Scores/Limits | Report sections: companyIdentification contactInformation otherInformation |
Directors | director | Company Directors and Shareholders/Share Capitol Structure Current Directors Previous Directors Share Capital Structure (Shareholders + Issued Shares) No Scores/Limits | Report sections: directors shareCapitalStructure |
Group Structure | groupstructure | Company subsidiaries Group Structure with hierarchical levels No Scores/Limits | Report sections: group structure extended group structure |
Negative Information | negativeinfo | local section "Negative Information" for example - Count Court Judgements in GB No Scores/Limits | Report section: negativeInformation |
Additional Information | additional | local section "Additional Information" Miscellaneous section that varies between territories. Can contain Enquiry Data Land Registry Commentaries History Bad Debt Persons of Significant Control Mortgages It is possible to contain historic scores/limits | Report section: additionalInformation |
Credit Score | score | Credit Score, International Rating and Credit Limit Current Credit Score Current Credit Limit Current International Score Current Contract Limit Probability of Default Previous Credit Rating Previous International Score | Report section: creditScore |
Payment Data | paymentdata | local section "Payment Data" No Scores/Limits | Report section: paymentData |
Local + Global Financials | financial | Up to 10 years of Financial Statements in two different structures - global/common structure and local customs. Balance Sheet Cash Flow Other Financials Ratios Audit Remarks No Scores/Limits | Report sections: globalFInancials localFInancials |
Reseller A | resellerA | Only common report sections Company Summary Company Identification Contact Information Other Information Credit Score Directors Global Financials Extended Group Structure Uncommon sections omitted - paymentData, additionalInfo, negativeInfo, localFinancials | This Template is a collection of all information contained in the templates 'Summary 'Basic' 'Score' "Directors' - only directors 'Group Structure' 'Financial' - only global financials |
Reseller B | resellerB | The full Company Report without sections that contain scores/limits. Company Identification Contact Information Other Information Directors Global Financials Local Financials Group Structure Extended Group Structure Negative Information Payment Data Scored section omitted - summary, creditScore and additionalInfo (can contain rating history) No Scores/Limits | This Template is a collection of all the information contained in the templates 'Basic' 'Financial' 'Directors' 'Group Structure' 'Negative Information' 'Payment Data' |
All data sections are subject to local availability.
Template Availability
Summary | Basic | Score | Group Structure | Directors | Financial | reseller A | reseller B | additional | Negative Info | Payment data | |
BE | x | x | x | x | x | x | x | x | x | x | x |
DE | x | x | x | x | x** | x | x | x | x | x | x |
DK | x | x | x | x | x | x | x | x | x | x | x |
FR | x | x | x | x | x | x | x | x | x | x | x |
IE | x | x | x | x | x | x | x | x | |||
NL | x | x | x | x | x | x | x | x | x | x | |
NO | x | x | x | x | x | x | x | x | |||
IT | local* template | local* template | x | x | x | local* template | x | x | x | x | |
JP | x | x | x | x | x | x | x | x | x | x | |
SE | x | x | x | x | x | x | x | x | x | x | |
UK | x | x | x | x | x | x | x | x | x | x | x |
US | x | x | x | x | x | x | x | x | x | x |
*IT has uncommon local templates due to different supplier cost models.
**German Director template only contains directors, not shareholders.
How to order a Company Report Template
Using the Template glossary, take the parameter name of the template you want to order and insert it it as a parameter in the following request:
Sandbox:
GET https://connect.sandbox.creditsafe.com/v1/companies/{connectId}?template={templateName}
Production:
GET https://connect.creditsafe.com/v1/companies/{connectId}?template={templateName}
You must have access to the template to order a templated company report. You can request this access through your account manager.