Skip to content
Country APIs Catalog/Search Engine/
/Consumer Search

Search for consumer data

Request

Search for individuals using personal identification number, name, address, or other details. Returns consumer information including personal identification number, name, address, status, and other details.

Important: At least one of the following parameters is required to perform a search: namesearchnumber, address, or cityorpostcode.

Security
bearerToken
Query
namesearchnumberstring, <= 255 characters

Complete or part of person's name or complete personal identity number (without hyphen). Name search is not case sensitive.

Note: At least one search parameter (namesearchnumber, address, or cityorpostcode) is required.

addressstring, <= 255 characters

Street address (with or without address number).

Note: At least one search parameter (namesearchnumber, address, or cityorpostcode) is required.

cityorpostcodestring, <= 60 characters

City and/or the post code (5 digits without space, e.g. "12345").

Note: At least one search parameter (namesearchnumber, address, or cityorpostcode) is required.

includeinactiveboolean

Whether to include inactive consumers in the search results. Default is false (inactive consumers are excluded).

Default:false
startpositioninteger, [ 1 .. 100 ]

Start position of the search result, must be between 1-100. Used if more than 50 search results in response. Default value is 1.

Default:1
pagesizeinteger, [ 1 .. 50 ]

Number of search results returned in the response. Must be between 1-50. Default is 25.

Default:25
transactionidstring, <= 14 characters

Optional. Customer's internal information (customer/invoice number). Recommended to use this field as it can be helpful in tracking your call in Creditsafe logs.

languagestring

Sets the language of the response

Default:"en"
Enum:"sv""en"
curl -i -X GET \
  'https://se-webservice.apps.creditsafe.com/search/consumer?namesearchnumber=string&address=string&cityorpostcode=string&includeinactive=false&startposition=1&pagesize=25&transactionid=string&language=sv' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response with consumer search results

Bodyapplication/json
metaDataobject

Metadata about the request

reportobject

Report object containing search results

Response
{
  "metaData": {
    "apiLogId": 0,
    "timeStamp": "2019-08-24T14:15:22Z",
    "resource": "string",
    "method": "string",
    "requestUrl": "string"
  },
  "report": {
    "results": [ … ],
    "totalCount": 0
  }
}