Graydon Creditsafe party provider
- Version 10
- Version 9
- Version 8
- Version 7
- Version 6
- Version 5
- Version 4
What's newβ
- Every stored credit report field is configured in
metadataMappings. The credit score, fraud risk score, company status, equity, capital, financial statement currency and additional NACE codes are no longer separate settings. They are now entries in the map:CREDIT_SCORE,FRAUD_RISK_SCORE,COMPANY_ACTIVE,TOTAL_SHAREHOLDERS_EQUITY,CALLED_UP_SHARE_CAPITAL,FINANCIAL_STATEMENT_CURRENCYandADDITIONAL_NACE_CODES. - Same data on the party. Each entry reads the same value and keeps the same write conditions as the V9 setting it replaces.
- Unchanged: company search, UBO retrieval,
legalEventDescriptionsandmaxEquityFinancialStatementAgeInYears.
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- financial metadata (equity, capital, currency where available)
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
- UBO data
Input data pointsβ
Companies can be searched by name, company number or VAT number (in addition to the required country). The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV10PartyProvider
Company searchβ
Unchanged from V9: only the criteria Creditsafe accepts for the chosen country are sent, a criterion that cannot work is skipped so the next one is tried, a search that cannot work at all is refused with an error naming the field to correct, and where Creditsafe does not offer exact name matching the results are narrowed locally.
UBO retrievalβ
The provider supports retrieval of Ultimate Beneficial Owner (UBO) profiles. The Creditsafe Connect company identifier associated with the selected company is reused to retrieve the corresponding UBO information.
Metadata mappingsβ
metadataMappings lists every Company Credit Report field that is stored on the party and the metadata key each one is stored under. Only the fields present in the map are mapped.
Where V9 configured the credit score, fraud risk score, company status, equity, capital, financial statement currency and additional NACE codes through a setting of their own, V10 configures them through that same map β as CREDIT_SCORE, FRAUD_RISK_SCORE, COMPANY_ACTIVE, TOTAL_SHAREHOLDERS_EQUITY, CALLED_UP_SHARE_CAPITAL, FINANCIAL_STATEMENT_CURRENCY and ADDITIONAL_NACE_CODES. Each reads exactly the same value as the setting it replaces, including the equity, capital and currency that come from the global financial statement for every country, so a configuration moved from V9 stores the same data on the party.
Each field also keeps the write conditions of the setting it replaces. CREDIT_SCORE, FRAUD_RISK_SCORE, COMPANY_ACTIVE and ADDITIONAL_NACE_CODES leave their metadata key untouched when Creditsafe reports no usable value, so refreshing a party does not overwrite what is stored with an empty value. FINANCIAL_STATEMENT_CURRENCY, TOTAL_SHAREHOLDERS_EQUITY and CALLED_UP_SHARE_CAPITAL are written as long as there is a financial statement, with an empty value when the figure is missing β and the equity is left empty when its financial year falls outside maxEquityFinancialStatementAgeInYears β so a refresh clears a value that no longer applies.
maxEquityFinancialStatementAgeInYears remains a setting of its own: it limits the equity mapping rather than naming a metadata key, in the same way legalEventDescriptions drives the legal event mappings. The additional NACE codes are stored as a list, so the key can be a multi-autocomplete field on a NACE code list.
β€΄οΈ Migration guide: V9 to V10β
V10 enriches the same data as V9 and searches the same way; only the settings change. Seven V9 settings are removed and move into metadataMappings under the key they already use:
| V9 setting | V10 metadataMappings entry |
|---|---|
metadataKeyCreditScore | CREDIT_SCORE |
metadataKeyFraudRiskScore | FRAUD_RISK_SCORE |
metadataKeyCompanyActive | COMPANY_ACTIVE |
metadataKeyEquity | TOTAL_SHAREHOLDERS_EQUITY |
metadataKeyCapital | CALLED_UP_SHARE_CAPITAL |
metadataKeyCurrency | FINANCIAL_STATEMENT_CURRENCY |
metadataAdditionalNaceCodes | ADDITIONAL_NACE_CODES |
Settingsβ
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- financial metadata (equity, capital, currency where available)
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
- UBO data
Input data pointsβ
Companies can be searched by name, company number or VAT number (in addition to the required country). The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV9PartyProvider
Company searchβ
V9 takes the same settings as V8 and enriches the same data. What differs is the company search: only the criteria Creditsafe accepts for the chosen country are sent.
Creditsafe publishes a fixed set of mutually exclusive search criteria per country, and rejects any other combination, any value that violates the published length or format, and any country it cannot search. Each of those rejections used to reach the user as a provider error, or as a silent no-match when the search ran automatically. V9 follows the published rules instead:
- One criterion per search. The VAT number takes precedence over the company number, which takes precedence over the company name β the same order as the earlier versions. A criterion the country does not offer, or a value that does not fit its format, is skipped so the next one down is used instead β a malformed company number no longer hides a company name that would have matched.
- VAT number. Not available in every country. Switzerland, Luxembourg, Norway, Canada, China, Hong Kong, Iceland, Lithuania, Malta, Singapore, Taiwan, Turkey, Cyprus and the United Arab Emirates, among others, cannot be searched by VAT number.
- Company number. Available in most countries but not all β Taiwan, for instance, can only be searched by name. Many countries enforce a format: the Dutch registration number must be 8 or 12 digits, the French one 9 or 14, the Polish one 3 to 10 digits.
- Company name. Always available, with a country-specific minimum length: 1 character in Germany and Sweden, 2 in the Netherlands, France, Austria and Italy, 3 in Poland, Singapore and Taiwan.
- Belgium is not affected. Belgium searched successfully before this change and keeps behaving exactly as it did.
- Exact name matching. Creditsafe only offers this in a subset of countries. Where it is unavailable the provider searches on the name without it and narrows the results itself, so resolving a party by its exact name works in every country.
- Address. For the automated identifier resolution only (not the manual search form), the party's street, postal code and city narrow the name search wherever Creditsafe accepts them for the country β never as a standalone criterion, and never for a company-number or VAT-number search. Which of the three fields a country accepts varies: most accept city, many also accept postal code and street, some (e.g. Cyprus, Taiwan) accept none at all, in which case the address is left out and the plain name search is used.
- Unsupported countries. Creditsafe cannot search Gibraltar, the Isle of Man, Jersey, Guernsey, Israel, the Faroe Islands or Vatican City. A search on one of those is refused with
CREDITSAFE_COUNTRY_NOT_SUPPORTED.
When none of the supplied criteria is usable for the chosen country, the search is refused with CREDITSAFE_INVALID_SEARCH_CRITERIA and the API response states which field to correct.
UBO retrievalβ
The provider supports retrieval of Ultimate Beneficial Owner (UBO) profiles. The Creditsafe Connect company identifier associated with the selected company is reused to retrieve the corresponding UBO information.
Additional NACE codesβ
As in V8, the additional NACE codes are stored as a list instead of the comma-separated string of the earlier versions, so the configured metadata key can be a multi-autocomplete field on a NACE code list. A company without additional codes leaves the metadata key unset.
Equity financial yearβ
By default the equity of the most recent financial statement is stored, however old that statement is. An FSP that only accepts recent figures configures maxEquityFinancialStatementAgeInYears: the equity is then only stored when the financial year of that statement is at or after the current calendar year minus the configured number of years. The window is rolling, so it moves with the calendar year without reconfiguration β with a maximum age of 2, a statement of 2024 or 2025 is accepted in 2026 and a statement of 2023 is not.
The window decides whether the equity of the latest statement is stored, not which statement is read: when the latest statement is too old the equity is left empty instead of falling back to an older one. The capital and the currency are unaffected.
Settingsβ
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- financial metadata (equity, capital, currency where available)
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
- UBO data
Input data pointsβ
Companies can be searched by name, company number or VAT number (in addition to the required country). The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV8PartyProvider
Company searchβ
In addition to searching by company name and company number, the provider supports searching by VAT number. When a VAT number is provided, it takes precedence and is used as the sole search criterion.
UBO retrievalβ
The provider supports retrieval of Ultimate Beneficial Owner (UBO) profiles. The Creditsafe Connect company identifier associated with the selected company is reused to retrieve the corresponding UBO information.
Additional NACE codesβ
The additional NACE codes are stored as a list instead of the comma-separated string of the earlier versions, so the configured metadata key can be a multi-autocomplete field on a NACE code list. A company without additional codes leaves the metadata key unset.
Settingsβ
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- financial metadata (equity, capital, currency where available)
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
- UBO data
Input data pointsβ
Companies can be searched by name, company number or VAT number (in addition to the required country). The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV7PartyProvider
Company searchβ
In addition to searching by company name and company number, the provider supports searching by VAT number. When a VAT number is provided, it takes precedence and is used as the sole search criterion.
UBO retrievalβ
The provider supports retrieval of Ultimate Beneficial Owner (UBO) profiles. The Creditsafe Connect company identifier associated with the selected company is reused to retrieve the corresponding UBO information.
Settings:β
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- financial metadata (equity, capital, currency where available)
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
- UBO data
Input data pointsβ
The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV6PartyProvider
UBO retrievalβ
The provider supports retrieval of Ultimate Beneficial Owner (UBO) profiles. The Creditsafe Connect company identifier associated with the selected company is reused to retrieve the corresponding UBO information.
Settings:β
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
Input data pointsβ
The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV5PartyProvider
Settings:β
relationType{XYZ}(optional): Defines the mapping for the specific relation type to be used within the application. If arelationTypeis left blank or set tonull, the mapping logic for that specific relation will be skipped, and those parties will not be imported.sharesMetadataKey(optional): defines the field where you want to store the total share of a related party.metadataKeyCreditScore(optional): defines the field where you want to store the companyβs credit score.metadataKeyFraudRiskScore(optional): defines the field where you want to store the companyβs fraud risk score.maxAssociatedPartiesCount(optional): when there are more related parties returned than defined in this property, the import will not be performed and result in a provider failure (default value is50).metadataKeyForExternalRefIdentifier(optional): defines the metadata key to store the Creditsafe identifier (Connect ID) in the party's metadata. If not defined, the identifier will be stored in the party's external reference field.- Note: This metadata key can only be used for searching a party and not for related parties.
skipMappingFor(optional): Defines the keys to identify which data/response mapping logic should be skipped.- see mapping example below for more settings related to the mapping of relation types and metadata fields
Example(s)β
Settings Configuration
Examples
π― Functional documentationβ
This provider can be used to enrich
- international company party data
- with Fraud Risk Score and Credit Score (BE only)
- international related parties
Input data pointsβ
The Creditsafe identifier (Connect ID) will be stored in the party's external reference field, unless a specific metadata key is defined in the settings.
βοΈ Configurationβ
Required authorization settingsβ
clientIdclientSecretresourceUri:https://connect.creditsafe.com/v1/
Implementation classβ
CreditsafeV4PartyProvider
Settings:β
relationType{XYZ}(required): define a mapping for the relation type that should be used in the application.sharesMetadataKey(optional): defines the field where you want to store the total share of a related party.metadataKeyCreditScore(optional): defines the field where you want to store the companyβs credit score.metadataKeyFraudRiskScore(optional): defines the field where you want to store the companyβs fraud risk score.maxAssociatedPartiesCount(optional): when there are more related parties returned than defined in this property, the import will not be performed and result in a provider failure (default value is50).metadataKeyForExternalRefIdentifier(optional): defines the metadata key to store the Creditsafe identifier (Connect ID) in the party's metadata. If not defined, the identifier will be stored in the party's external reference field.- Note: This metadata key can only be used for searching a party and not for related parties.
skipMappingFor(optional): Defines the keys to identify which data/response mapping logic should be skipped.- see mapping example below for more settings related to the mapping of relation types and metadata fields
Example(s)β
Configuration with mapping of relation types and metadata fields
{
"PROVIDER_DISPLAY_NAME": "Creditsafe",
"relationTypeAffiliatedCompanies": "AFFILIATED_COMPANIES",
"relationTypeDirector": "DIRECTOR",
"relationTypeDirectorManager": "DIRECTOR_MANAGER",
"relationTypeImmediateParent": "IMMEDIATE_PARENT",
"relationTypeShareholder": "SHAREHOLDER",
"relationTypeSubsidiary": "SUBSIDIARY",
"relationTypeUltimateParent": "ULTIMATE_PARENT",
"sharesMetadataKey": "total_shares",
"metadataKeyCreditScore": "creditScore",
"metadataKeyFraudRiskScore": "fraudRiskScore",
"skipMappingFor": ["LEGAL_FORM"]
}