{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/Credit&Risk/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/creditrisk/creditandrisk"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Additional Search and Report Options","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"additional-search-and-report-options","__idx":0},"children":["Additional Search and Report Options"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This document describes optional endpoints that complement the core company search and report workflow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints provide additional functionality for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieving country-specific report schemas"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Checking available report languages before requesting a report"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"company-report-response-schemas","__idx":2},"children":["Company Report Response Schemas"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint retrieves the response schema for a company report in a specific country. It provides a detailed breakdown of the property structure for reports from that country."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Understand report structure before requesting data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validate expected response fields"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Map report data to your system"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Support developer onboarding"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint","__idx":3},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /companies/schema/{countryCode}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters","__idx":4},"children":["Path Parameters"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$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":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO2 country code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DE"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-parameters","__idx":5},"children":["Query Parameters"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":"code","attributes":{},"children":["section"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Section to retrieve (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CompanyReportResponse"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":6},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /companies/schema/US?section=CompanyReportResponse\nAuthorization: Bearer <token>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":7},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema\": {\n    \"companyName\": \"string\",\n    \"registrationNumber\": \"string\",\n    \"address\": \"object\",\n    \"financials\": \"object\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors","__idx":8},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid country code or section parameter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Schema not found for specified country or section"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-company-report-languages","__idx":9},"children":["Available Company Report Languages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint retrieves the available report languages for a specific country. Use this to determine which language options are supported before requesting a company report."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-1","__idx":10},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /access/countries/{countryCode}/reportLanguages\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-1","__idx":11},"children":["Path Parameters"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$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":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO2 country code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":12},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /access/countries/BR/reportLanguages\nAuthorization: Bearer <token>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":13},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"reportLanguages\": [\n    \"PT\"\n  ],\n  \"correlationId\": \"e90e0934-06d9-4cf8-94a5-8e1fa568bd02\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-fields","__idx":14},"children":["Response 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":"code","attributes":{},"children":["reportLanguages"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of available language codes for reports in this country"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for support tracking"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors-1","__idx":15},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid country code format"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country not found or not supported"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage-guidance","__idx":16},"children":["Usage Guidance"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"when-to-use-report-schemas","__idx":17},"children":["When to Use Report Schemas"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check the report schema when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrating with the API for the first time"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Building data mapping for a new country"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validating response structure in automated tests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Documenting expected fields for downstream systems"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"when-to-use-report-languages","__idx":18},"children":["When to Use Report Languages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check available languages when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Building a multi-language user interface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supporting international users"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Determining default language for report requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validating language parameter before requesting reports"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-documentation","__idx":19},"children":["Related Documentation"]},{"$$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":"Resource"},"children":["Resource"]},{"$$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":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies"},"children":["Company Search and Report Workflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Core workflow for searching companies and retrieving reports"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["How to authenticate with the API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/errorcodes"},"children":["Error Codes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Complete error code reference"]}]}]}]}]}]},"headings":[{"value":"Additional Search and Report Options","id":"additional-search-and-report-options","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Company Report Response Schemas","id":"company-report-response-schemas","depth":2},{"value":"Endpoint","id":"endpoint","depth":3},{"value":"Path Parameters","id":"path-parameters","depth":3},{"value":"Query Parameters","id":"query-parameters","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"Common Errors","id":"common-errors","depth":3},{"value":"Available Company Report Languages","id":"available-company-report-languages","depth":2},{"value":"Endpoint","id":"endpoint-1","depth":3},{"value":"Path Parameters","id":"path-parameters-1","depth":3},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Example Response","id":"example-response-1","depth":3},{"value":"Response Fields","id":"response-fields","depth":3},{"value":"Common Errors","id":"common-errors-1","depth":3},{"value":"Usage Guidance","id":"usage-guidance","depth":2},{"value":"When to Use Report Schemas","id":"when-to-use-report-schemas","depth":3},{"value":"When to Use Report Languages","id":"when-to-use-report-languages","depth":3},{"value":"Related Documentation","id":"related-documentation","depth":2}],"frontmatter":{"seo":{"title":"Additional Search and Report Options"}},"lastModified":"2026-07-23T08:59:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/additionalsearchandreportoptions","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}