Skip to content

Metadata Section

Every time a report request is sent, the Search Engine service returns a metaData section in the response. This section contains useful information about the request, which can help with tracing and troubleshooting.


MetaData Fields

The metaData section includes the following fields:

FieldTypeDescription
apiLogIdIntegerA unique identifier for the Creditsafe API log. Please refer to this ID when contacting Creditsafe support, as it allows them to access the full context of your request
timeStampString (DateTime)The exact time when the request was processed by Creditsafe
resourceStringIndicates which service delivered the report
methodStringSpecifies the HTTP method used for the request
requestUrlStringThe complete URL of the request sent to Creditsafe

Example MetaData Response

{
  "metaData": {
    "apiLogId": 233255,
    "timeStamp": "2025-10-06T06:12:03",
    "resource": "Company Search (1225)",
    "method": "GET",
    "requestUrl": "https://se-webservice.apps.creditsafe.com/search/company?language=sv&namesearchnumber=TheCompany"
  }
}

When MetaData is Included

This metadata is included in the response for both successful and error responses, as long as the request was handled by the Creditsafe service.


Using MetaData for Support

Troubleshooting with apiLogId

When contacting Creditsafe support about a specific request, always include the apiLogId from the metaData section. This unique identifier allows the support team to quickly locate and review the full context of your request, significantly speeding up the troubleshooting process.


Complete Response Example

A complete successful response includes both the report array and the metaData section:

{
  "metaData": {
    "apiLogId": 233255,
    "timeStamp": "2025-10-06T06:12:03",
    "resource": "Company Search (1225)",
    "method": "GET",
    "requestUrl": "https://se-webservice.apps.creditsafe.com/search/company?language=sv&namesearchnumber=TheCompany"
  },
  "report": {
    "results": [
      {
      "organizationNumber": 5565144408,
      "companyName": "Creditsafe i Sverige AB",
      "statusType": "Positive",
      "statusText": "Aktiv",
      "companyType": "AB"
      }
    ],
  "totalCount": 1
  }
}

Service Identification

The resource field in the metaData identifies which Search Engine service was used:

  • Company Search (1225) - Company search endpoint
  • Consumer Search (1226) - Consumer search endpoint

This can be helpful when troubleshooting issues specific to one type of search.