Documentation REST

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.

API's

This product offers four API’s to receive information. The fifth API (Company Search API) 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 API’s:

API

Description

Company Search API

https://api.postnl.nl/company/creditcheck/v1/search

API allows to search the company you want to request a credit report for

Credit Flag API

https://api.postnl.nl/company/creditcheck/v1/creditflag

API that delivers a Credit Flag of the requested company.

Credit Advice API

https://api.postnl.nl/company/creditcheck/v1/creditadvice

API that provides a Credit Advice of the requested company.

Creditworthiness API

https://api.postnl.nl/company/creditcheck/v1/creditworthiness

API that delivers a Credit Flag and a Credit Advice of the requested company.

Creditworthiness API

Large

https://api.postnl.nl/company/creditcheck/v1/creditworthinesslarge

API that delivers a Credit Flag, Credit Advice and PD Rating of the requested company.

Call details

Preview the API call buildup below.

API 0 - Company Search API

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: 4 numbers 2 letters. First number cannot be 0.

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.
051840003915625N354N364
051800000000000                          02

There are different input parameters. To receive a response at least one parameter has to be used. A summary of the different combinations (methods) that can be used:

Parameter

Method 1

Method 2

Method 3

Method 4

Method 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

Sample request 1 using postalcode and housenumber:

{
    "kvkNumber": "",
    "postalCode": "8031 EC ",
    "houseNumber": "24",
    "city": "",
    "searchKeywords": "",
    "telephoneNumber": "",
    "postalCode": "",
    "keyNextSearch":""
}

Sample request 2 using kvknumber:

{
    "kvkNumber": "05111111",
    "postalCode": "",
    "houseNumber": "",
    "city": "",
    "searchKeywords": "",
    "telephoneNumber": "",
    "postalCode": ""
    "keyNextSearch":""
}

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.
051840003915625N354N364          
051800000000000                          02

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

Sample response:

{
  "mainMessage": "OK",
  "numberOfHitsFound": "1",
  "foundMore": "0",
  "keyNextSearch": "",
  "searchResults": [
  {


    "headOfficeInd": "1",
    "companyIdentification": "000533885",
    "companyName": "HOLLANDSE HARDHOUTBEDRIJVEN B.V.",
    "streetName": "INDUSTRIEWEG",
    "houseNumber": "24",
    "houseNumberAddition": "",
   "postalCode": "8031 EC"
}

API 1 - Credit Flag API:

Requests

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

Sample request

{
"companyIdentification": "533885",
}

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

creditFlag

String

The credit flag Indicates the amount of risk

Red= high risk

Orange = increased risk

Green = low risk

Groen (=Green)

Oranje (=Orange)

Groen (=Green)

financialCalamityStatus

String

The financial calamity  status of the company:

Bankruptcy

Moratorium

Debt restructuring for Private Persons

Bankruptcy

 

discontinuanceType

String

Numeric type of discontinuance status of the company

00001 = intention to dissolve

00002 = finalized dissolution

00003 = untraceable

              (unknown) company

00004 = dissolved

00005 = liquidated company

00006 = according to Graydon 

              no longer active

00007 = dissolved (more than

              7 years)

00002

discontinuanceReason

String

Reason for the discontinuance status

An intention to dissolve this company has been submitted to the Chamber of Commerce

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)

Depending on the status of the company the following fields will be completed:

Standard

Financial Calamity

Discontinuance

mainMessage

mainMessage

mainMessage

additionalMessage

additionalMessage

additionalMessage

CompanyIdentification 

CompanyIdentification 

CompanyIdentification 

creditFlag

 

 

 

financialCalamityStatus

 

 

 

discontinuanceType

 

 

discontinuanceReason

Sample response

{
  "mainMessage": "OK",
  "additionalMessage": "",
  "companyIdentification": "533885",
  "creditFlag": "Oranje",
  "financialCalamityStatus": "",
  "discontinuanceType": "",
  "discontinuanceReason": ""
}

API 2 - Credit Advice API:

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

Sample request

{
"companyIdentification": "533885",
}

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

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

Depending on the status of the company the following fields will be completed:

Standard

Financial Calamity

Discontinuance

mainMessage

mainMessage

mainMessage

additionalMessage

additionalMessage

additionalMessage

CompanyIdentification 

CompanyIdentification 

CompanyIdentification 

creditAdvice

 

 

 

financialCalamityStatus

 

 

 

discontinuanceType

 

 

discontinuanceReason

Sample response

{
  "mainMessage": "OK",
 "additionalMessage": "",
  "companyIdentification": "533885",
  "creditAdvice": "700000"
  "financialCalamityStatus": "",
   "discontinuanceType": "",
   "discontinuanceReason": ""
}

API 3 - Creditworthiness API

Requests

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

Sample request

{
"companyIdentification": "533885",
}

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 Indicates the amount of risk

Red= high risk

Orange = increased risk

Green = low risk

Groen (=Green)

Oranje (=Orange)

Groen (=Green)

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

Depending on the status of the company the following fields will be completed:

Standard

Financial Calamity

Discontinuance

mainMessage

mainMessage

mainMessage

additionalMessage

additionalMessage

additionalMessage

CompanyIdentification 

CompanyIdentification 

CompanyIdentification 

creditAdvice

 

 

creditFlag

 

 

 

financialCalamityStatus

 

 

 

discontinuanceType

 

 

discontinuanceReason

Sample response

{
  "mainMessage": "OK",
  "additionalMessage": "",
  "companyIdentification": "533885",
  "creditAdvice": "700000",
  "creditFlag": "Oranje"
  "financialCalamityStatus": "",
   "discontinuanceType": "",
   "discontinuanceReason": ""
}
  }

API 4 - Creditworthiness Large API

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

Sample request

{
"companyIdentification": "533885",
}

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:

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

CC

creditFlag

String

The credit flag Indicates the amount of risk

Red= high risk

Orange = increased risk

Green = low risk

Groen (=Green)

Oranje (=Orange)

Groen (=Green)

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

Depending on the status of the company the following fields will be completed:

Standard

Financial Calamity

Discontinuance

mainMessage

mainMessage

mainMessage

additionalMessage

additionalMessage

additionalMessage

CompanyIdentification 

CompanyIdentification 

CompanyIdentification 

creditAdvice

 

 

pdRating

 

 

creditFlag

 

 

 

financialCalamityStatus

 

 

 

discontinuanceType

 

 

discontinuanceReason

Sample response

{
  "mainMessage": "OK",
  "additionalMessage": "",
  "companyIdentification": "533885",
  "creditAdvice": "700000",
  "pdRating": "CC",
  "creditFlag": " Oranje "
  "financialCalamityStatus": "",
   "discontinuanceType": "",
   "discontinuanceReason": ""
}

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