{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-country-apis-catalog/product-catalog/se/searchEngine/sidebars.yaml","current-catalog-info":"current-catalog-info-/country-apis-catalog/product-catalog/se/searchengine/openapi"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Metadata Section","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"metadata-section","__idx":0},"children":["Metadata Section"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every time a report request is sent, the Search Engine service returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metaData"]}," section in the response. This section contains useful information about the request, which can help with tracing and troubleshooting."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"metadata-fields","__idx":1},"children":["MetaData Fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metaData"]}," section includes the following fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["apiLogId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A 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"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["timeStamp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (DateTime)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The exact time when the request was processed by Creditsafe"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["resource"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates which service delivered the report"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["method"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the HTTP method used for the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["requestUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The complete URL of the request sent to Creditsafe"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-metadata-response","__idx":2},"children":["Example MetaData Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"metaData\": {\n    \"apiLogId\": 233255,\n    \"timeStamp\": \"2025-10-06T06:12:03\",\n    \"resource\": \"Company Search (1225)\",\n    \"method\": \"GET\",\n    \"requestUrl\": \"https://se-webservice.apps.creditsafe.com/search/company?language=sv&namesearchnumber=TheCompany\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-metadata-is-included","__idx":3},"children":["When MetaData is Included"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This metadata is included in the response for both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["successful and error responses"]},", as long as the request was handled by the Creditsafe service."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-metadata-for-support","__idx":4},"children":["Using MetaData for Support"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Troubleshooting with apiLogId"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When contacting Creditsafe support about a specific request, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["always include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"complete-response-example","__idx":5},"children":["Complete Response Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A complete successful response includes both the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]}," array and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metaData"]}," section:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"metaData\": {\n    \"apiLogId\": 233255,\n    \"timeStamp\": \"2025-10-06T06:12:03\",\n    \"resource\": \"Company Search (1225)\",\n    \"method\": \"GET\",\n    \"requestUrl\": \"https://se-webservice.apps.creditsafe.com/search/company?language=sv&namesearchnumber=TheCompany\"\n  },\n  \"report\": {\n    \"results\": [\n      {\n      \"organizationNumber\": 5565144408,\n      \"companyName\": \"Creditsafe i Sverige AB\",\n      \"statusType\": \"Positive\",\n      \"statusText\": \"Aktiv\",\n      \"companyType\": \"AB\"\n      }\n    ],\n  \"totalCount\": 1\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"service-identification","__idx":6},"children":["Service Identification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resource"]}," field in the metaData identifies which Search Engine service was used:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company Search (1225)"]}," - Company search endpoint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consumer Search (1226)"]}," - Consumer search endpoint"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This can be helpful when troubleshooting issues specific to one type of search."]}]},"headings":[{"value":"Metadata Section","id":"metadata-section","depth":1},{"value":"MetaData Fields","id":"metadata-fields","depth":2},{"value":"Example MetaData Response","id":"example-metadata-response","depth":2},{"value":"When MetaData is Included","id":"when-metadata-is-included","depth":2},{"value":"Using MetaData for Support","id":"using-metadata-for-support","depth":2},{"value":"Complete Response Example","id":"complete-response-example","depth":2},{"value":"Service Identification","id":"service-identification","depth":2}],"frontmatter":{"seo":{"title":"Metadata Section"}},"lastModified":"2026-08-10T15:19:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/country-apis-catalog/product-catalog/se/searchengine/documentation/metadata","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}