Creditsafe Connect API Documentation

Custom Report Parameters

Returns the allowed values of the customData parameter, used in the GET Company Report and Director Report endpoints. I.e. Supplying DE as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter customData = de_reason_code::allowedValue.

SecuritybearerToken

Request

path Parameters

country

required

string

An ISO/Alpha-2 country code to display any special mandatory parameters when ordering a Credit Report in that territory.

Responses

200

400

401

get/reportcustomdata/{country}

Request samples

Response samples

application/json

{"customData": [{"key": "de_reason_code",
"optional": false,
"allowedValues": ["1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
],
"description": ["DE report retrieval reason code:",
"1 - Credit Decision'",
"2 - Credit Assessment - Future business connection (with credit risk)",
"3 - Credit Assessment - Existing business connection (with credit risk)",
"4 - Realisation check receivables collection",
"5 - Purchase Contract - Intention of signature of purchase contract (with credit risk)",
"6 - Goods Credit Insurance (with credit risk)",
"7 - Contract - Intention of signature of leasing or rent contract (with credit risk)",
"8 - Insurance Contract - Intention of signature of a insurance contract (with credit risk)"
]
}
],
"country": "DE"
}