Skip to content
Connect API Catalog/
/
/
Consumer Report

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&callRef=%7BcallRef%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

Unique identifier for tracing the request.

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