Skip to content
Connect API Catalog/
/
/
Return Custom Report Para...

Consumer And Misc (1.0.0)

Endpoints to order Consumer Reports. In order to order a Consumer Report, sufficient information to uniquely identify the Consumer (search criteria) must be provided to filter potential results down to one record. When one record has been found, the returned object will be the Consumer Report. Currently only piloting with German Consumers.

Important Note on Response Structure

The response structure shown in this documentation represents the full set of fields that may be returned by the Consumer Report service.

Actual responses depend on the data available for the requested consumer. If certain information (e.g., incomes, property details, credit score) is not available, those fields will be omitted from the response.

Always implement your integration to handle missing or partial data gracefully.

Download OpenAPI description
consumerAndMisc.json
consumerAndMisc.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Authentication endpoint to obtain access token for API requests.

Operations

Consumers

Endpoints for searching and retrieving consumer credit reports based on provided search criteria.

Operations

Consumer Search Criteria

Request

Returns country specific fields that can be used to search for a Consumer.

Security
bearerToken
Query
countriesstringrequired

Comma-separated list of ISO-2 country codes

Example: countries=de
callRefstring

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/consumers/searchcriteria?countries=de&callRef=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
countriesArray of strings
Example: ["DE"]
criteriaSetsArray of objects
]
Response
application/json
[
  {
    "countries": [ … ],
    "criteriaSets": [ … ]
  }
]

Return Custom Report Parameters

Request

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.

Security
bearerToken
Path
countrystringrequired

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

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/reportcustomdata/{country}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
object
Response
application/json
{
  "customData": [
    { … }
  ],
  "country": "DE"
}

Consumer Report

Request

Consumer Search and Report endpoint. When sufficient information has been provided to filter potential Consumer results down to one record then the Consumer Report will be returned.

Security
bearerToken
Query
countriesstringrequired

ISO-2 country code. Only available for DE (Germany) and NL (Netherlands)

Example: countries=DE
languagestring or null= 2 characters
Default "EN"
firstNamestringrequired

Consumer's First Name

lastNamestringrequired

Consumer's Last Name

streetstringrequired

Address part identifier - Street of the Consumer

houseNostringrequired

Address part identifier - House/Building Number of the Consumer

citystringrequired

Address part identifier - City of the Consumer

postCodestringrequired

Address part identifier - Postcode/Zip Code of the Consumer

dateOfBirthstring or null(date-time)
customDatastring or null
Example: customData=de_reason_code::ER
callRefstring or null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Default null
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/consumers?countries=DE&language=EN&firstName=string&lastName=string&street=string&houseNo=string&city=string&postCode=string&dateOfBirth=2019-08-24T14%3A15%3A22Z&customData=de_reason_code%3A%3AER' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

Unique identifier for tracing the request.

totalSizeinteger(int32)
consumersArray of objects(CreditsafeGlobalDataReportsConsumerConsumerReport)
Response
application/json
{
  "correlationId": "string",
  "totalSize": 0,
  "consumers": [
    { … }
  ]
}