Skip to content
Last updated

Requests and Responses

Authentication

To be able to do a search for a company or consumer, you must first authenticate your user account. Please refer to the separate documentation titled Authenticate to SE Integration Services Manual for details on how to authenticate and obtain a token.

Token Usage

The generated token can be used across all Creditsafe Sweden REST APIs (see the Authentication document for the list of applicable services).


Production URLs

Company Search:

https://se-webservice.apps.creditsafe.com/search/company

Consumer Search:

https://se-webservice.apps.creditsafe.com/search/consumer

Request Methods

The Search Engine REST API includes two distinct GET methods: one for consumers and one for companies.

Company Search Request

Endpoint:

GET /search/company

Example Request:

HEADER: Authorization: Bearer <token>
URL: https://se-webservice.apps.creditsafe.com/search/company?namesearchnumber=TheCompany&companytype=AB
Method: GET

Consumer Search Request

Endpoint:

GET /search/consumer

Example Request:

HEADER: Authorization: Bearer <token>
URL: https://se-webservice.apps.creditsafe.com/search/consumer?namesearchnumber=Carl Persson&address=Storgatan
Method: GET

Request Parameters

The table below describes each parameter included in the search request:

ParameterData typeMax lengthRequiredDescription
namesearchnumber (query)String255Yes*Company: Complete or part of the company's name or the complete organization number (without hyphen)
Consumer: Complete or part of person's name or complete personal identity number (without hyphen)
Name search is not case sensitive.
address (query)String255Yes*Street address (with or without address number)
cityorpostcode (query)String60Yes*City and/or the post code (5 digits without space, e.g. "12345")
telephone (query)String20Yes*Telephone number with or without hyphen
Note: This search value will actually also give a response if the number matches a fax. Maximum 20 characters (will be truncated if longer).
Only available for company search
companytype (query)String-NoAB, EF, HBKB (combined HB and KB), or Other
Only available for company search
includeinactive (query)Boolean-Notrue/false. Default is false (inactive companies/consumers are excluded by default).
Available for both company and consumer search
startposition (query)Number-NoStart position of the search result, must be between 1-100. Used if more than 50 search results in response.
Default value is 1.
pagesize (query)Number-NoNumber of search results returned in the response.
Must be between 1-50. Default is 25.
transactionid (query)String14NoCustomer's internal information (customer/invoice number).
Recommended to use this field as it can be helpful in tracking your call in Creditsafe logs.
language (query)String3NoSets the language of the response
Available languages: sv or en. Default: en

*At least one of these parameters is required to perform a search

Sandbox Parameter Behavior

Developers are encouraged to structure their requests as they would in a production environment, including all expected parameters. This ensures consistency and simplifies the transition to production usage. However, it is important to understand that in sandbox mode, unsupported parameters will not influence the response and should not be relied upon for testing behavior or data validation.


Response (Successful)

The response format from the Search Engine REST API is similar, but not identical, for consumers and companies. The change codes that may appear differ between the two.

Null Values

Please note that parameters with a null value are hidden in the responses of Creditsafe's REST APIs.

Company Response Example

HTTP Response code: 200 OK

{
  "metaData": {
    "apiLogId": 6028905,
    "timeStamp": "2026-07-13T13:50:48",
    "resource": "Company Search (1225)",
    "method": "GET",
    "requestUrl": "https://se-webservice.apps.creditsafe.com/search/company?namesearchnumber=5565144408"
  },
  "report": {
    "results": [
      {
        "organizationNumber": 5564441054,
        "companyName": "Test Aktiebolag",
        "previousCompanyName": "Aktiebolaget Föredetta",
        "address": {
          "careOf": "c/o Karlsson",
          "street": "Storgatan 12",
          "zipCode": 123456,
          "town": "GÖTEBORG",
          "addressType": 1,
          "addressTypeText": "Registered address"
        },
        "oldAddress": "Storgatan 13",
        "phone": "031-123456",
        "statusType": "Positive",
        "statusText": "Aktiv",
        "isPartOfGroup": false,
        "lastAccountPeriod": "2401-2412",
        "companyType": "AB",
        "companyTypeText": "Privat aktiebolag",
        "companyLegalGroup": "AB"
      }
    ],
    "totalCount": 1
  }
}

Consumer Response Example

HTTP Response code: 200 OK

{
  "metaData": {
    "apiLogId": 6028914,
    "timeStamp": "2026-07-13T13:51:45",
    "resource": "Consumer Search (1226)",
    "method": "GET",
    "requestUrl": "https://se-webservice.apps.creditsafe.com/search/consumer?namesearchnumber=198209170250"
  },
  "report": {
    "results": [
      {
        "personalIdentificationNumber": 196612121212,
        "name": "Karin Testperson",
        "givenName": "Karin",
        "statusTypeText": "Aktiv",
        "statusType": "Active",
        "isActive": true,
        "address": {
          "street": "Lilla gränden 1",
          "zipCode": 12345,
          "town": "BJUV",
          "addressType": 1,
          "addressTypeText": "Registered address"
        },
        "oldAddress": null,
        "specialAddress": null,
        "oldSpecialAddress": null
      }
    ],
    "totalCount": 1
  }
}
Address Fields

Please note that oldAddress, specialAddress and oldSpecialAddress would not show if they are null but here we show them for information purposes.


Response Parameters

The Search Engine returns different parameters for companies and consumers.

Company Response Parameters

ParameterData typeDescription
organizationNumberNumberCompany organization number
companyNameStringCurrent registered company name
previousCompanyNameStringPrevious name if company was renamed
addressObjectRegistered address details containing: careOf, street, zipCode, town, addressType, addressTypeText
oldAddressObjectPrevious address if available (same structure as address)
phoneStringContact phone number
statusTypeStringCompany status code (e.g., "Positive")
statusTextStringCompany status description (e.g., "Aktiv")
isPartOfGroupBooleanIndicates if company is part of a group structure
lastAccountPeriodStringMost recent accounting period (format: YYMM-YYMM)
companyTypeStringLegal form code (AB, HB, KB, EF, etc.)
companyTypeTextStringLegal form description (e.g., "Privat aktiebolag")
companyLegalGroupStringLegal group classification

Consumer Response Parameters

ParameterData typeDescription
personalIdentificationNumberNumberPerson's identity number (12 digits)
nameStringFull name
givenNameStringFirst name
statusTypeStringPerson status code (e.g., "Active")
statusTextStringPerson status description (e.g., "Aktiv")
isActiveBooleanIndicates if person record is active
addressObjectRegistered address details containing: street, zipCode, town, addressType, addressTypeText
oldAddressObjectPrevious address if available (same structure as address)
specialAddressObjectSpecial postal address if registered (same structure as address)
oldSpecialAddressObjectPrevious special address if available (same structure as address)
Null Values

Parameters with a null value are hidden in the responses of Creditsafe's REST APIs.


Understanding the Response

The Search Engine API returns an array of matching results based on your search criteria:

  • Multiple results - The report object contains a results array with multiple matches. Use startposition and pagesize parameters to paginate through large result sets
  • Similar matches - Name searches are fuzzy and will return close matches, not just exact matches
  • Status filtering - Use includeinactive=false to exclude inactive companies from results
  • Address variations - The address object may contain null fields depending on what data is registered for the entity
  • Company type filtering - Specify companytype to narrow results to specific legal forms

For more detailed information about a specific company or consumer found in the search results, use the GetData API with the organization number or personal identity number.