Documentation
Kredietcheck Zakelijk
Summary
With the Kredietcheck Zakelijk API’s you receive creditworthiness information about your customers in the form of a Credit Flag, Credit Advice, PD rating (Probability of Default), or a combination of the above.
Methods
This product offers four methods to receive information. The fifth (Company Search) allows you to search the “company identification number” of the company you want the details from. This “company identification number” is required input for all four methods:
Note: This API supports the GET method.
Method | Description | |
Company Search | Allows to search the company you want to request a credit report for | |
Credit Flag | Delivers a Credit Flag of the requested company. | |
Credit Advice | Provides a Credit Advice of the requested company. | |
Creditworthiness | https://api.postnl.nl/company/creditcheck/v1/creditworthiness | Delivers a Credit Flag and a Credit Advice of the requested company. |
Creditworthiness Large | https://api.postnl.nl/company/creditcheck/v1/creditworthinesslarge | Delivers a Credit Flag, Credit Advice and PD Rating of the requested company. |
Call details
Preview the API call buildup below.
Company Search
Requests
The following input parameters should be used for the Company Search API:
Attribute | Format | Description | Example |
kvkNumber | String [8] | Chamber of Commerce number of the requested company | 12345678 |
postalCode | regex
| Zipcode of the requested company | 1020BC |
houseNumber | String | The house number of the requested company
| 12 |
city | String [24] | City of the requested company
Can only be used in combination with searchkeywords | Amsterdam |
searchKeyWords | String [132]
| For example name of the company
Can be used in combination with city | PostNL |
telephoneNumber | String [12]
| Dutch telephone number, only valid if written as 020-5679999 or 0205679999 | 020-5679999 or 0205679999 |
keyNextSearch | String [128] | Key to include in a second request to collect the additional found companies that are not in the initial result | 10HOLLANDSE HARDHOUTBEDRIJVEN B.V.
|
Postal code Pattern:
Pattern postalcode is [1-9][0-9]{3}(?!SA|SD|SS)[A-Z]{2};
Four numbers, not starting with 0 followed by two characters not equal to SA/SD/SS.
Input parameters
There are different input parameters. To receive a response different combinations of parameters are mandatory (M) and optional (O):
Parameter | Comb 1 | Comb 2 | Comb 3 | Comb 4 | Comb 5 |
kvkNumber | M |
|
|
|
|
postalCode |
| M |
|
| O |
houseNumber |
| M |
|
| O |
city |
| O | M | O | O |
searchKeywords |
| O | M | M | O |
telephoneNumber |
| O | O | O | M |
keyNextSearch | O | O | O | O | O |
Response
The following output parameters are returned:
Attribute | Format | Description | Example |
mainMessage | String [80] | Main message indicates whether a request was successful (OK) or not (Error) | OK or Error |
additionalMessage | String [80] | additional message indicates the reason why a request was not successful | Distributieformaat onbekend (see error overview) |
numberOfHitsFound | String [128] | Number of hits found | 3 |
foundMore | String [1] | Field indicates whether the are more companies found then the companies in the result | 1 (yes) or 0 (no) |
keyNextSearch | String [128] | The key to include in a second request to collect the additional found companies that are not in the initial result | 10HOLLANDSE HARDHOUTBEDRIJVEN B.V.
|
headOfficeInd | String [1] | Field indicates whether the company found is the head office | 1 (yes) or 0 (no) |
companyIdentification | String [9] | The Graydon Company Identification number | 000533885 |
companyName | String [132] | company name of the company found | HOLLANDSE HARDHOUTBEDRIJVEN B.V. |
streetName | String [50] | Name of the street where the company is based | INDUSTRIEWEG |
houseNumber | String [5] | House number of the company | 24 |
houseNumberAddition | String [12] | Housenumber extension | A |
postalCode | String [10] | Zipcode of the company found | 8031 EC |
The following input parameters should be used for Credit Flag API:
Attribute | Mandatory | Format | Description | Example |
CompanyIdentification | M | String [9] | Graydon Company Identification number | 000533885 |
The following output parameters are returned:
Attribute | Format | Description | Example |
mainMessage | String [80] | Main message indicates whether a request was successful (OK) or not (Error) | OK or Error |
additionalMessage | String [80] | Additional message indicates the reason why a request was not successful | Distributieformaat onbekend (see error overview) |
companyIdentification | String [9] | The Graydon Company Identification number of the requested company | 533885 |
creditFlag | String | The credit flag indicates the amount of risk See overview Credit Flag. | Groen |
financialCalamityStatus | String | The financial calamity status of the company.: See overview Financial Calamity Status. | Bankruptcy
|
discontinuanceType | String | Numeric type of discontinuance status of the company. See overview DiscontinuanceReason. | 00002 |
discontinuanceReason | String | Reason for the discontinuance status | An intention to dissolve this company has been submitted to the Chamber of Commerce |
Overview Credit Flag
Rood = Red= high risk
Oranje = Orange = increased risk
Groen = Green = low risk
Overview Financial Calamity Status
Bankruptcy
Moratorium
Debt restructuring for Private Persons
Overview DiscontinuanceReason
Type | Reason (in English) |
00001 | An intention to dissolve this company has been submitted to the Chamber of Commerce |
00002 | The dissolution of this company has been finalized by the Chamber of Commerce |
00003 | An investigation did not produce the desired result |
00004 | Investigation has shown that the company you have requested has been dissolved |
00005 | Investigation has shown that the company you have requested has been liquidated |
00006 | According to Graydon no longer active |
00007 | Investigation has shown that the company you have requested has been dissolved (for more than 7 years) |
Credit Advice
Requests
The following input parameters should be used for the Credit Advice API:
Attribute | Mandatory | Format | Description | Example |
CompanyIdentification | M | String [9] | Graydon Company Identification number | 000533885 |
The following output parameters are returned:
Attribute | Format | Description | Example |
mainMessage | String [80] | Main message indicates whether a request was successful (OK) or not (Error) | OK or Error |
additionalMessage | String [80] | Additional message indicates the reason why a request was not successful | Distributieformaat onbekend (see error overview) |
companyIdentification | String [9] | The Graydon Company Identification number of the requested company | 533885 |
creditAdvice | String | The credit amount advice in EUR | 700000 |
financialCalamityStatus | String | The financial calamity status (see overview) of the company:
| Bankruptcy |
discontinuanceType | String | Numeric type of discontinuance status (see overview) of the company | 00002 |
discontinuanceReason | String | Reason for the discontinuance status | An intention to dissolve this company has been submitted to the Chamber of Commerce |
The following input parameters should be used for the Creditworthiness API
Attribute | Mandatory | Format | Description | Example |
CompanyIdentification | M | String [9] | Graydon Company Identification number | 000533885 |
Response
The following output parameters are returned:
Attribute | Format | Description | Example |
main message | String [80] | Main message indicates whether a request was successful (OK) or not (Error) | OK or Error |
additional message | String [80] | Additional message indicates the reason why a request was not successful | Distributieformaat onbekend (see error overview) |
companyIdentification | String [9] | The Graydon Company Identification number of the requested company | 533885 |
creditadvice | String | The credit amount advice in EUR | 700000 |
creditFlag | String | The credit flag (see overview) indicates the amount of risk | Groen |
financialCalamityStatus | String | The financial calamity status (see overview) of the company:
| Bankruptcy
|
discontinuanceType | String | Numeric type of discontinuance status (see overview) of the company
| 00002 |
discontinuanceReason | String | Reason for the discontinuance status | An intention to dissolve this company has been submitted to the Chamber of Commerce |
Creditworthiness Large
Requests
The following input parameters should be used for the Creditworthiness Large API
Attribute | Mandatory | Format | Description | Example |
CompanyIdentification | M | String [9] | Graydon Company Identification number | 000533885 |
Response
The following output parameters are returned:
Attribute | Format | Description | Example |
mainMessage | String [80] | Main message indicates whether a request was successful (OK) or not (Error) | OK or Error |
additionalMessage | String [80] | Additional message indicates the reason why a request was not successful | Distributieformaat onbekend (see error overview) |
companyIdentification | String [9] | The Graydon Company Identification number of the requested company | 533885 |
creditadvice | String | The credit amount advice in EUR | 700000 |
pdRating | String | Probability of Default rating. See Probability overview | CC |
creditFlag | String | The credit flag Indicates the amount of risk. See overview credit flags | Groen |
financialCalamityStatus | String | The financial calamity status of the company
| Bankruptcy
|
discontinuanceType | String | Numeric type of discontinuance status of the company | 00002 |
discontinuanceReason | String | Reason for the discontinuance status | An intention to dissolve this company has been submitted to the Chamber of Commerce |
Overview Probability of Default rating
AAA very low risk
AA low risk
A low risk
BBB average risk
BB average risk
B average risk
CCC increased risk
CC increased risk
C high risk
D bankrupt
NR No rating possible
Status codes
The following status codes can be returned under main message
Attribute | Description |
OK | OK |
Error | Not-OK |
The following status codes are examples of the messages that could be returned under “additionalMessage” if the response is “Error” in the “mainMessage” field.
Status Code | Description (NL) | Description (UK) |
17 | Bedrijf is failliet | Company is bankrupt |
18 | Bedrijf is opgegaan in ander bedrijf | Company has merged with another company |
72 | Bedrijf niet gevonden | Company not found |
88 | Systeemfout; errorcode={0} | System error: errorcode = |
94 | Er waren teveel requests in een gegeven periode. Probeer het later | Too many request. Try again later |
99999 | Systeemfout | Graydon System error |