{ "openapi": "3.0.4", "info": { "title": "HitHorizons US API", "description": "Get in touch with our team to obtain a subscription key. We provide free, time-limited trial access to test the API and evaluate the data in the API.", "version": "v1" }, "paths": { "/us/Company/Detail": { "get": { "tags": [ "Company" ], "summary": "This endpoint provides the data of a single company identified by HitHorizons ID.", "description": "Returns comprehensive company data including:\r\n- Basic company information (name, address, registration details)\r\n- Financial and employee data\r\n- Contact details (website, email, phone and social media)\r\n- IndustryCode classification (SIC, NACE and Local activity codes)\r\n- Company executives and CEO\r\n- Corporate structure\r\n- Digital commerce\r\n- Additional information\r\n \r\n \r\n### Example Request\r\n```\r\nGET /us/Company/Detail?HitHorizonsId=H-USSD123456789\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": {\r\n \"HitHorizonsId\": \"H-USSD0001234567\",\r\n \"CompanyName\": \"Acme Manufacturing Corp, Ltd.\",\r\n \"DirectoryName\": \"Acme Manufacturing Corp\",\r\n \"CompanySecondaryName\": null,\r\n \"Address\": {\r\n \"Street1\": \"100 Industrial Way\",\r\n \"Street2\": null,\r\n \"PostalCode\": \"12345\",\r\n \"City\": \"Springfield\",\r\n \"CountyDistrict\": \"Example County\",\r\n \"StateProvince\": \"Texas\",\r\n \"Geo\": {\r\n \"GeoLevelDescription\": \"House\",\r\n \"Longitude\": -100.123456,\r\n \"Latitude\": 35.123456,\r\n \"GeoLevel\": 7,\r\n \"BuildingName\": null,\r\n \"BuildingType\": null,\r\n \"BuildingGeom\": null,\r\n \"BuildingArea\": null,\r\n \"LastUpdate\": null\r\n }\r\n },\r\n \"NationalId\": null,\r\n \"NationalIdType\": null,\r\n \"EstablishmentOfOwnership\": null,\r\n \"CompanyType\": 0,\r\n \"LocationType\": 2,\r\n \"SalesLocal\": 0,\r\n \"LocalCurrency\": null,\r\n \"SalesUSD\": 0,\r\n \"SalesEUR\": 0,\r\n \"SalesAccuracyIndicator\": 2,\r\n \"EmployeesNumber\": 50,\r\n \"EmployeesNumberAccuracyIndicator\": 3,\r\n \"EmployeesNumberLocal\": 50,\r\n \"EmployeesNumberLocalAccuracyIndicator\": 3,\r\n \"EmployeesNumberTotal\": 50,\r\n \"EmployeesNumberTotalAccuracyIndicator\": 9,\r\n \"Contacts\": {\r\n \"Websites\": [],\r\n \"Phones\": [\"555 123 4567\"],\r\n \"Faxes\": [],\r\n \"Emails\": [],\r\n \"SocialURLs\": []\r\n },\r\n \"SIC\": [\r\n {\r\n \"IndustryText\": \"Manufacturing\",\r\n \"IndustryCode\": \"D\",\r\n \"SICText\": \"Mfg fiber cans/drums, etc\",\r\n \"SICCode\": \"2655\"\r\n },\r\n {\r\n \"IndustryText\": \"Manufacturing\",\r\n \"IndustryCode\": \"D\",\r\n \"SICText\": \"Mfg plastic products\",\r\n \"SICCode\": \"3089\"\r\n }\r\n ],\r\n \"NACE\": [\r\n {\r\n \"NACEText\": \"Manufacture of corrugated paper and paperboard\",\r\n \"NACECode\": \"1721\"\r\n },\r\n {\r\n \"NACEText\": \"Manufacture of builders ware of plastic\",\r\n \"NACECode\": \"2223\"\r\n }\r\n ],\r\n \"LocalActivity\": [],\r\n \"SubsidiaryIndicator\": 0,\r\n \"CorporateStructure\": {\r\n \"DiasCode\": \"012345678\",\r\n \"HierarchyCode\": 1,\r\n \"NumberOfFamilyMembers\": 2,\r\n \"Relations\": [\r\n {\r\n \"RelationType\": \"Parent\",\r\n \"HitHorizonsID\": null,\r\n \"Name\": \"Acme Manufacturing Corp, Ltd.\",\r\n \"Address\": {\r\n \"Street1\": \"200 Corporate Blvd\",\r\n \"Street2\": null,\r\n \"PostalCode\": \"77001\",\r\n \"City\": \"Houston\",\r\n \"CountyDistrict\": null,\r\n \"StateProvince\": null,\r\n }\r\n },\r\n {\r\n \"RelationType\": \"Global Ultimate\",\r\n \"HitHorizonsID\": null,\r\n \"Name\": \"Acme Manufacturing Corp, Ltd.\",\r\n \"Address\": {\r\n \"Street1\": \"200 Corporate Blvd\",\r\n \"Street2\": null,\r\n \"PostalCode\": \"77001\",\r\n \"City\": \"Houston\",\r\n \"CountyDistrict\": null,\r\n \"StateProvince\": null,\r\n }\r\n }\r\n ]\r\n },\r\n \"CEO\": {\r\n \"FullName\": \"Jane Doe\",\r\n \"Title\": \"Manager\",\r\n \"FirstName\": \"JANE\",\r\n \"LastName\": \"DOE\"\r\n },\r\n \"Executives\": [\r\n {\r\n \"FullName\": \"Jane Doe\",\r\n \"Title\": \"Office Manager\",\r\n \"FirstName\": \"JANE\",\r\n \"LastName\": \"DOE\"\r\n }\r\n ],\r\n \"HistoricalData\": [\r\n {\r\n \"SalesEUR\": 0,\r\n \"SalesUSD\": 0,\r\n \"SalesLocal\": 0,\r\n \"SalesIndicator\": 2,\r\n \"Currency\": null,\r\n \"Employees\": null,\r\n \"EmployeesIndicator\": 2,\r\n \"EmployeesLocal\": 50,\r\n \"EmployeesLocalIndicator\": 3,\r\n \"Year\": 2025\r\n }\r\n ],\r\n \"DigitalCommerce\": [],\r\n \"AdditionalInformation\": {\r\n \"Language\": \"ENG\",\r\n \"ImportExportAgentCodeDescription\": \"None or Not Available\",\r\n \"MarketabilityIndicator\": \"M\"\r\n }\r\n }\r\n}\r\n```", "parameters": [ { "name": "HitHorizonsId", "in": "query", "description": "A unique company identification number assigned by HitHorizons (e.g., H-USSD123456789)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the company details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailResultApiResponse" } } } }, "400": { "description": "If the HitHorizonsId parameter is missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailResultApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "404": { "description": "If the company is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailResultApiResponse" } } } } } } }, "/us/Company/Search": { "get": { "tags": [ "Company" ], "summary": "This endpoint allows you to search the company database using a structured query.", "description": "Returns a list of companies matching the search criteria including:\r\n- Basic company information (name, address, registration details)\r\n- Financial data (sales in EUR and USD)\r\n- Employee count\r\n- Industry classification (SIC code)\r\n- Company and location type\r\n- Contact details (website, email, phone and social media)\r\n \r\nImportant Note:\r\nDefault search includes partnerships, corporations, and proprietorships.\r\nFor other company types or branches, manual selection is required. Ensure to adjust these settings according to your specific search requirements.\r\n \r\n### Example Request\r\n```\r\nGET /us/Company/Search?CompanyName=Acme&StateProvince=Texas&MaxResults=20\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": {\r\n \"Results\": [\r\n {\r\n \"HitHorizonsId\": \"H-USSD0001234567\",\r\n \"CompanyName\": \"Acme Manufacturing Corp\",\r\n \"CompanySecondaryName\": null,\r\n \"AddressStreetLine1\": \"100 Industrial Way\",\r\n \"AddressStreetLine2\": null,\r\n \"PostalCode\": \"12345\",\r\n \"City\": \"Springfield\",\r\n \"CountyDistrict\": \"Example County\",\r\n \"StateProvince\": \"Texas\",\r\n \"NationalId\": \"0001234567\",\r\n \"SICCode\": \"2655\",\r\n \"IndustryCode\": \"D\",\r\n \"EstablishmentOfOwnership\": 1995,\r\n \"SalesEUR\": 50000,\r\n \"SalesUSD\": 54000,\r\n \"EmployeesNumber\": 50,\r\n \"CompanyType\": 3,\r\n \"LocationType\": 0,\r\n \"Websites\": null,\r\n \"Emails\": null,\r\n \"Phones\": [\"555 123 4567\"],\r\n \"SocialURLs\": null\r\n }\r\n ],\r\n \"ResultsCount\": 20,\r\n \"TotalCount\": 1953\r\n }\r\n}\r\n```", "parameters": [ { "name": "CompanyName", "in": "query", "description": "Official name of the company.", "schema": { "type": "string" } }, { "name": "CompanyNameExact", "in": "query", "description": "Query to search for exact company name.", "schema": { "type": "string" } }, { "name": "NationalId", "in": "query", "description": "Company identification number officially assigned and used in some countries for company incorporation and tax collection.", "schema": { "type": "string" } }, { "name": "AddressUnstructured", "in": "query", "description": "Query to search for in the company address.", "schema": { "type": "string" } }, { "name": "AddressStreet", "in": "query", "description": "Query to search for in the company street address.", "schema": { "type": "string" } }, { "name": "PostalCode", "in": "query", "description": "Query to search for in the company postal code.", "schema": { "type": "string" } }, { "name": "City", "in": "query", "description": "Query to search for in the company city.", "schema": { "type": "string" } }, { "name": "CountyDistrict", "in": "query", "description": "Query to search for in the company county/district or county.", "schema": { "type": "string" } }, { "name": "StateProvince", "in": "query", "description": "Query to search for in the company state/province.", "schema": { "type": "string" } }, { "name": "CompanyTypes", "in": "query", "description": "Array of company types to return. When not supplied, only the following company types are returned:\r\n0, 3, 12, 13.\r\nRefer to the HitHorizons API Code lists (companyType) for the values applicable for this field.\r\nIf set to empty value, all company types are returned.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ShowBranches", "in": "query", "description": "When false, only companies indicated as single-location or headquarters are returned (LocationType = 0 or 1).\r\nWhen true, all companies are returned.\r\nWhen not specified, false is used by default.", "schema": { "type": "boolean" } }, { "name": "Website", "in": "query", "description": "Query to search for in company websites.", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "description": "Query to search for in company email contacts.", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "description": "Query to search for in company phone contacts.", "schema": { "type": "string" } }, { "name": "SocialUrl", "in": "query", "description": "Query to search for in any company social media URLs (LinkedIn, Facebook, X).\r\nTo search within a specific platform, include the platform name in your query, e.g., \"linkedin acme\"", "schema": { "type": "string" } }, { "name": "MaxResults", "in": "query", "description": "Maximum number of results to return (optional)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns the list of matching companies", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchResponseApiResponse" } } } }, "400": { "description": "If the filter parameters are invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchResponseApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } } } } }, "/us/Company/SearchUnstructured": { "get": { "tags": [ "Company" ], "summary": "This endpoint allows you to search the company database by using an unstructured query.\r\nIt is suitable when you have incomplete data on companies in your system and you need to complete it.", "description": "Returns a list of companies matching the search criteria including:\r\n- Basic company information (name, address, registration details)\r\n- Financial data (sales in EUR and USD)\r\n- Employee count\r\n- Industry classification (SIC code)\r\n- Company and location type\r\n- Contact details (website, email, phone and social media)\r\n \r\nImportant Note:\r\nDefault search includes partnerships, corporations, and proprietorships.\r\nFor other company types or branches, manual selection is required. Ensure to adjust these settings according to your specific search requirements.\r\n \r\n### Example Request\r\n```\r\nGET /us/Company/SearchUnstructured?Name=Acme&Address=Texas&MaxResults=20\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": {\r\n \"Results\": [\r\n {\r\n \"HitHorizonsId\": \"H-USSD0001234567\",\r\n \"CompanyName\": \"Acme Manufacturing Corp\",\r\n \"CompanySecondaryName\": null,\r\n \"AddressStreetLine1\": \"100 Industrial Way\",\r\n \"AddressStreetLine2\": null,\r\n \"PostalCode\": \"12345\",\r\n \"City\": \"Springfield\",\r\n \"CountyDistrict\": \"Example County\",\r\n \"StateProvince\": \"Texas\",\r\n \"NationalId\": \"0001234567\",\r\n \"SICCode\": \"2655\",\r\n \"IndustryCode\": \"D\",\r\n \"EstablishmentOfOwnership\": 1995,\r\n \"SalesEUR\": 50000,\r\n \"SalesUSD\": 54000,\r\n \"EmployeesNumber\": 50,\r\n \"CompanyType\": 3,\r\n \"LocationType\": 0,\r\n \"Websites\": null,\r\n \"Emails\": null,\r\n \"Phones\": [\"555 123 4567\"],\r\n \"SocialURLs\": null\r\n }\r\n ],\r\n \"ResultsCount\": 2,\r\n \"TotalCount\": 2\r\n }\r\n}\r\n```", "parameters": [ { "name": "Ids", "in": "query", "description": "All types of company IDs can be used – HitHorizons number, national ID.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Name", "in": "query", "description": "Name of the company.", "schema": { "type": "string" } }, { "name": "Address", "in": "query", "description": "Query to search in company address. This field can contain an English country name at the end – in such case, the search is limited to the given country.", "schema": { "type": "string" } }, { "name": "ShowBranches", "in": "query", "description": "When false, only companies indicated as single-location or headquarters are returned (LocationType = 0 or 1).\r\nWhen true, all companies are returned.\r\nWhen not specified, false is used by default.", "schema": { "type": "boolean" } }, { "name": "CompanyTypes", "in": "query", "description": "Array of company types to return. When not supplied, only the following company types are returned:\r\n0, 3, 12, 13.\r\nRefer to the HitHorizons API Code lists (companyType) for the values applicable for this field.\r\nThis value can be provided as a comma-separated list of values, instead of an array of values (i.e. CompanyTypes=3,13, instead of CompanyTypes=3&CompanyTypes=13).\r\nIf set to empty value, all company types are returned (CompanyTypes=).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MaxResults", "in": "query", "description": "Maximum number of results to return. Maximum of 100 results is supported. 20 when not supplied (optional)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns the list of matching companies", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchResponseApiResponse" } } } }, "400": { "description": "If the filter parameters are invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchResponseApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } } } } }, "/us/Company/Suggestions": { "get": { "tags": [ "Company" ], "summary": "This endpoint allows you to search for companies using a company name.\r\nIf fewer companies than specified are found, results of company name suggestions are returned.\r\nThis is useful for populating dropdown selectors for autocomplete scenarios.", "description": "Returns a list of company suggestions matching the query including:\r\n- Basic company information (HitHorizonsId, name)\r\n- Location information (postal code, province, region)\r\n- National ID (if available)\r\n \r\n### Example Request\r\n```\r\nGET /us/Company/Suggestions?Query=Acme&MaxResults=10\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": [\r\n {\r\n \"HitHorizonsId\": \"H-USSD0001234567\",\r\n \"Name\": \"Acme Corp\",\r\n \"PostalCode\": \"12345\",\r\n \"CountyDistrict\": \"Example County\",\r\n \"StateProvince\": \"Texas\",\r\n \"NationalId\": null\r\n },\r\n {\r\n \"HitHorizonsId\": \"H-USSD0009876543\",\r\n \"Name\": \"Acme Industries, L.P.\",\r\n \"PostalCode\": \"67890\",\r\n \"CountyDistrict\": \"Sample County\",\r\n \"StateProvince\": \"California\",\r\n \"NationalId\": \"0001234567\"\r\n }\r\n ]\r\n}\r\n```", "parameters": [ { "name": "Query", "in": "query", "description": "Company name query. Minimum length is 3 characters.", "schema": { "type": "string" } }, { "name": "SkipSuggestions", "in": "query", "description": "When true, only existing companies will be returned in the response. No suggestions will be added to fill the response when fewer than MaxResults companies are found. This is useful to make the endpoint respond faster in such cases.", "schema": { "type": "boolean" } }, { "name": "MaxResults", "in": "query", "description": "Maximum number of results to return. Maximum of 20 results is supported. 20 when not supplied (optional)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns the list of company suggestions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySuggestionListApiResponse" } } } }, "400": { "description": "If the Query parameter is missing or too short", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySuggestionListApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } } } } }, "/us/Company/CodeLists": { "get": { "tags": [ "Company" ], "summary": "This endpoint allows you to retrieve code lists for values used in the API.", "description": "Returns a dictionary of code lists including:\r\n- CompanyType - List of company type codes and descriptions\r\n- LocationType - List of location type codes and descriptions\r\n- SocialURLType - List of social URLs type codes and descriptions\r\n- EmployeesAccuracyIndicator - List of accuracy indicators for employees number\r\n- SalesAccuracyIndicator - List of accuracy indicators for sales\r\n- SubsidiaryIndicator - List of subsidiary indicators and descriptions\r\n- HierarchyCode - List of hierarchy codes and descriptions for corporate structure\r\n- LocalActivityCodeType - List of activity systems\r\n \r\nThese code lists can be used to interpret coded values returned by other endpoints\r\nand to populate dropdown selectors in user interfaces.\r\n \r\n### Example Request\r\n```\r\nGET /us/Company/CodeLists\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": {\r\n \"CompanyType\": [\r\n {\r\n \"Code\": \"0\",\r\n \"Value\": \"Unknown Type\",\r\n \"Parameters\": null\r\n },\r\n {\r\n \"Code\": \"3\",\r\n \"Value\": \"corporation\",\r\n \"Parameters\": null\r\n },\r\n {\r\n \"Code\": \"12\",\r\n \"Value\": \"partnership of unknown type\",\r\n \"Parameters\": null\r\n },\r\n {\r\n \"Code\": \"13\",\r\n \"Value\": \"proprietorship\",\r\n \"Parameters\": null\r\n }\r\n ],\r\n \"LocationType\": [\r\n {\r\n \"Code\": \"0\",\r\n \"Value\": \"single\",\r\n \"Parameters\": null\r\n },\r\n {\r\n \"Code\": \"1\",\r\n \"Value\": \"parent\",\r\n \"Parameters\": null\r\n }\r\n ]\r\n }\r\n}\r\n```", "responses": { "200": { "description": "Returns the code lists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringCodeListValueArrayDictionaryApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } } } } }, "/us/Company/CodeListsActivityCodes": { "get": { "tags": [ "Company" ], "summary": "This endpoint allows you to retrieve activity code lists used in the API.", "description": "Returns a dictionary of activity code lists that can be used to interpret\r\nactivity code values returned by other endpoints and to populate dropdown\r\nselectors in user interfaces.\r\n \r\n### Example Request\r\n```\r\nGET /us/Company/CodeLists/ActivityCodes\r\n```\r\n \r\n### Example Response\r\n```json\r\n{\r\n \"Success\": true,\r\n \"Error\": null,\r\n \"Result\": {\r\n \"SICCode\": [\r\n {\r\n \"Code\": \"0111\",\r\n \"Value\": \"Wheat farm\",\r\n \"Parameters\": {\r\n \"IndustryCode\": \"A\"\r\n }\r\n },\r\n {\r\n \"Code\": \"0112\",\r\n \"Value\": \"Rice farm\",\r\n \"Parameters\": {\r\n \"IndustryCode\": \"A\"\r\n }\r\n }\r\n ],\r\n \"NACECode\": [\r\n {\r\n \"Code\": \"0100\",\r\n \"Value\": \"Crop and animal production, hunting and related service activities\",\r\n \"Parameters\": {\r\n \"IndustryCode\": \"A\"\r\n }\r\n },\r\n {\r\n \"Code\": \"0110\",\r\n \"Value\": \"Growing of non-perennial crops\",\r\n \"Parameters\": {\r\n \"IndustryCode\": \"A\"\r\n }\r\n }\r\n ],\r\n \"LocalActivityCode\": [\r\n {\r\n \"Code\": \"111000\",\r\n \"Value\": \"Crop Production\",\r\n \"Parameters\": {\r\n \"LocalActivityCodeType\": \"112\",\r\n \"IndustryCode\": \"A\"\r\n }\r\n },\r\n {\r\n \"Code\": \"111100\",\r\n \"Value\": \"Oilseed and Grain Farming\",\r\n \"Parameters\": {\r\n \"LocalActivityCodeType\": \"112\",\r\n \"IndustryCode\": \"A\"\r\n }\r\n }\r\n ]\r\n }\r\n}\r\n```", "responses": { "200": { "description": "Returns the activity code lists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringCodeListValueArrayDictionaryApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectApiResponse" } } } }, "401": { "description": "If the API key is invalid or missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } }, "429": { "description": "If the rate limit is exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorResponse" } } } } } } } }, "components": { "schemas": { "AccessErrorResponse": { "type": "object", "properties": { "statusCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "linkText": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "popupTitle": { "type": "string", "nullable": true }, "popupMessage": { "type": "string", "nullable": true }, "popupLinkText": { "type": "string", "nullable": true }, "popupLink": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Address": { "type": "object", "properties": { "Street1": { "type": "string", "description": "Name of the street and house number (Address line 1).", "nullable": true }, "Street2": { "type": "string", "description": "Name of the street and house number (Address line 2).", "nullable": true }, "PostalCode": { "type": "string", "description": "Postal code / ZIP code.", "nullable": true }, "City": { "type": "string", "description": "Name of the city.", "nullable": true }, "CountyDistrict": { "type": "string", "description": "Name of the county or district.", "nullable": true }, "StateProvince": { "type": "string", "description": "Name of the state or province.", "nullable": true }, "Geo": { "$ref": "#/components/schemas/Geolocation" } }, "additionalProperties": false, "description": "Represents the physical address of a company including street, city, postal code, province, region, country, and geolocation data." }, "CodeListValue": { "type": "object", "properties": { "Code": { "type": "string", "description": "Item code.", "nullable": true }, "Value": { "type": "string", "description": "Item value.", "nullable": true }, "Parameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional parameters for the item, depending on the code list.", "nullable": true } }, "additionalProperties": false, "description": "Represents a single item in a code list." }, "Commerce": { "type": "object", "properties": { "Shop": { "type": "string", "description": "E-commerce platform used by the business (e.g., shopify, magento, woocommerce, bigcommerce, prestashop, etc.).", "nullable": true }, "OtherShop": { "type": "string", "description": "Review and/or rating website tools (e.g., trustami, trustedShops, backInStock).", "nullable": true }, "PaymentProvider": { "type": "string", "description": "Payment provider used by the business (e.g., stripe, paypal, klarna, adyen, braintree, square, etc.).", "nullable": true }, "SimplePaymentRule": { "type": "string", "description": "Payment method accepted (e.g., visa, mastercard, amex, applepay, googlepay, venmo, etc.).", "nullable": true }, "MarketingAutomation": { "type": "string", "description": "Marketing automation tool used by the business (e.g., mailchimp, hubspot, klaviyo, activeCampaign, marketo, etc.).", "nullable": true } }, "additionalProperties": false, "description": "Represents digital commerce and technographics data for a company including e-commerce platforms, payment providers, and marketing tools." }, "CompanyDetailResult": { "type": "object", "properties": { "HitHorizonsId": { "type": "string", "description": "A unique company identification number assigned by HitHorizons. (e.g., H-USSD123456789)", "nullable": true }, "CompanyName": { "type": "string", "description": "The registered business name of the company. Also known as BusinessName or FullName.", "nullable": true }, "DirectoryName": { "type": "string", "description": "The name to be published in directories (White and/or Yellow Pages). Also known as ListedName or ListingName.", "nullable": true }, "CompanySecondaryName": { "type": "string", "description": "The trade name or secondary name of the company. Also known as TradeName or TradeStyle (Doing business as).", "nullable": true }, "Address": { "$ref": "#/components/schemas/Address" }, "NationalId": { "type": "string", "description": "National identification number of the company.", "nullable": true }, "NationalIdType": { "type": "string", "description": "National identification number type code, as it can be different per country.", "nullable": true }, "EstablishmentOfOwnership": { "type": "integer", "description": "Setup year of the business.", "format": "int32", "nullable": true }, "CompanyType": { "type": "integer", "description": "Code that identifies the legal status/structure of the business. Possible codes: 0 = Not Available, 3 = Corporation, 12 = Partnership, 13 = Proprietorship.", "format": "int32", "nullable": true }, "LocationType": { "type": "integer", "description": "Code that provides business location type. Values: 0 = Single location (no other entities report to the business), 1 = Headquarter/Parent (branches and/or subsidiaries report to the business), 2 = Branch (secondary location to a headquarter location).", "format": "int32", "nullable": true }, "SalesLocal": { "type": "number", "description": "Sales value for the business in local currency. Can be a consolidated figure including all subsidiary and branch locations or a non-consolidated figure.", "format": "double", "nullable": true }, "LocalCurrency": { "type": "string", "description": "Code indicating which currency the financial figures data (Sales) is represented in.", "nullable": true }, "SalesUSD": { "type": "number", "description": "Sales value for the business in US dollars. If collected in different local currency, values are converted to US dollars based on the date of the financial figures/statement.", "format": "double", "nullable": true }, "SalesEUR": { "type": "number", "description": "Sales volume in EUR currency.", "format": "double", "nullable": true }, "SalesAccuracyIndicator": { "type": "integer", "description": "Sales volume reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "EmployeesNumber": { "type": "integer", "description": "The number of employees.", "format": "int32", "nullable": true }, "EmployeesNumberAccuracyIndicator": { "type": "integer", "description": "Employees reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "EmployeesNumberLocal": { "type": "integer", "description": "The number of employees at this location.", "format": "int32", "nullable": true }, "EmployeesNumberLocalAccuracyIndicator": { "type": "integer", "description": "Employees here reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "EmployeesNumberTotal": { "type": "integer", "description": "The total number of employees in the business organization. Can be a consolidated figure including employee counts for the business and all subsidiary and branch locations, or a non-consolidated figure.", "format": "int32", "nullable": true }, "EmployeesNumberTotalAccuracyIndicator": { "type": "integer", "description": "Employees total reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "Contacts": { "$ref": "#/components/schemas/Contacts" }, "SIC": { "type": "array", "items": { "$ref": "#/components/schemas/SICActivityCode" }, "description": "Standard Industrial Classification (SIC) activity codes with descriptions and industry codes.", "nullable": true }, "NACE": { "type": "array", "items": { "$ref": "#/components/schemas/NACEActivityCode" }, "description": "NACE (Statistical Classification of Economic Activities in the European Community) business classification codes.", "nullable": true }, "LocalActivity": { "type": "array", "items": { "$ref": "#/components/schemas/LocActivityCode" }, "description": "Local business activity codes. For US, this is typically NAICS (North American Industry Classification System).", "nullable": true }, "CorporateStructure": { "$ref": "#/components/schemas/CompanyRelations" }, "CEO": { "$ref": "#/components/schemas/Person" }, "Executives": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "description": "List of executives and other personnel at the company with their positions and contact details.", "nullable": true }, "HistoricalData": { "type": "array", "items": { "$ref": "#/components/schemas/Stats" }, "description": "Historical financial data including sales figures, employee counts, and their reliability codes for multiple years.", "nullable": true }, "DigitalCommerce": { "type": "array", "items": { "$ref": "#/components/schemas/Commerce" }, "description": "Digital commerce and technographics data including e-commerce platforms (Shop), payment providers, payment methods, and marketing automation tools.", "nullable": true }, "AdditionalInformation": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional information including Language, ImportExportAgentCodeDescription, MarketabilityIndicator, UniversalPublicationId, IsPublished, PublishingStrength, and OpeningHours.", "nullable": true } }, "additionalProperties": false }, "CompanyDetailResultApiResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Error": { "type": "string", "nullable": true }, "Result": { "$ref": "#/components/schemas/CompanyDetailResult" } }, "additionalProperties": false }, "CompanyRelations": { "type": "object", "properties": { "SubsidiaryIndicator": { "type": "integer", "description": "Indicator whether this company is a subsidiary.\r\nOne-character code.\r\nNote that branches always carry 0, even when their headquarters is itself a subsidiary.\r\n0 = not a subsidiary\r\n3 = is a subsidiary\r\nblank = unlinked", "format": "int32", "nullable": true }, "DiasCode": { "type": "string", "description": "DIAS (Data Integration and Analysis System) code for corporate linkage.\r\nNine-digit numeric sort key used to group records belonging to the same corporate family so they appear contiguously\r\n(ultimate parent first, followed by branches and subsidiaries). This value is derived and may change whenever linkage\r\ndata is updated, so it should not be used as a stable join key.\r\nExample: Take Hasbro's corporate family. Hasbro Inc. is the ultimate parent and gets the lowest DIAS value in its family.\r\nSierra/Affinity LLC, a subsidiary of Hasbro, gets a value immediately after it. Any branches of Hasbro would be listed\r\nbefore Sierra/Affinity (branches first, geographically sorted), and other Hasbro subsidiaries would follow alphabetically after.\r\nSo if you sort the dataset by diasCode, all 124 members of the Hasbro family appear together as a contiguous block,\r\nwith Hasbro at the top, then its branches, then its subsidiaries (Sierra/Affinity among them) in order —\r\nand the next block belongs to the next corporate family entirely. Hasbro Inc. might have DIAS 033711485,\r\nSierra/Affinity LLC has 033711486, the next family member 033711487, and so on.\r\nSorting by DIAS puts them in order next to each other, but each record has its own number.", "nullable": true }, "HierarchyCode": { "type": "integer", "description": "Hierarchy code indicating the company's position in the corporate structure.\r\nTwo-digit depth indicator within the corporate family tree.\r\nSubsidiaries are assigned one level deeper than their parent.\r\nBranches inherit the hierarchy level of their headquarters rather than increasing it.There is no enforced maximum depth.\r\n01 = ultimate parent\r\n02, 03, etc. = progressively deeper levels", "format": "int32", "nullable": true }, "NumberOfFamilyMembers": { "type": "integer", "description": "The number of family members including the global ultimate and all subsidiaries and branches of the entire family tree worldwide. Every family member carries the same count. Blank if not linked.", "format": "int32", "nullable": true }, "Relations": { "type": "array", "items": { "$ref": "#/components/schemas/Relation" }, "description": "Array of corporate relationships (Parent, Domestic Ultimate, Global Ultimate).", "nullable": true } }, "additionalProperties": false, "description": "Represents corporate linkage information including parent company relationships, domestic and global ultimate companies." }, "CompanySearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySearchResult" }, "nullable": true }, "ResultsCount": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanySearchResponseApiResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Error": { "type": "string", "nullable": true }, "Result": { "$ref": "#/components/schemas/CompanySearchResponse" } }, "additionalProperties": false }, "CompanySearchResult": { "type": "object", "properties": { "HitHorizonsId": { "type": "string", "description": "A unique company identification number assigned by HitHorizons. (e.g., H-USSD123456789)", "nullable": true }, "CompanyName": { "type": "string", "description": "The registered business name of the company. Also known as BusinessName or FullName.", "nullable": true }, "CompanySecondaryName": { "type": "string", "description": "The trade name or secondary name of the company. Also known as TradeName or TradeStyle (Doing business as).", "nullable": true }, "AddressStreetLine1": { "type": "string", "description": "The first line of the company street address.", "nullable": true }, "AddressStreetLine2": { "type": "string", "description": "The second line of the company street address.", "nullable": true }, "PostalCode": { "type": "string", "description": "The postal code of the company address.", "nullable": true }, "City": { "type": "string", "description": "The city of the company address.", "nullable": true }, "CountyDistrict": { "type": "string", "description": "The county or district of the company address.", "nullable": true }, "StateProvince": { "type": "string", "description": "The state or province of the company address.", "nullable": true }, "NationalId": { "type": "string", "description": "National identification number of the company.", "nullable": true }, "SICCode": { "type": "string", "description": "Standard Industrial Classification (SIC) activity code.", "nullable": true }, "IndustryCode": { "type": "string", "description": "Industry code associated with the SIC classification.", "nullable": true }, "EstablishmentOfOwnership": { "type": "integer", "description": "Setup year of the business.", "format": "int32", "nullable": true }, "SalesEUR": { "type": "number", "description": "Sales volume in EUR currency.", "format": "double", "nullable": true }, "SalesUSD": { "type": "number", "description": "Sales volume in USD currency.", "format": "double", "nullable": true }, "EmployeesNumber": { "type": "integer", "description": "The number of employees at this location.", "format": "int32", "nullable": true }, "CompanyType": { "type": "integer", "description": "Code that identifies the legal status/structure of the business. Possible codes: 0 = Not Available, 3 = Corporation, 8 = Joint Venture, 12 = Partnership, 13 = Proprietorship, 120 = Foreign Company.", "format": "int32", "nullable": true }, "LocationType": { "type": "integer", "description": "Code that provides business location type. Values: 0 = Single location (no other entities report to the business), 1 = Headquarter/Parent (branches and/or subsidiaries report to the business), 2 = Branch (secondary location to a headquarter location), 4 = Division.", "format": "int32", "nullable": true }, "Websites": { "type": "array", "items": { "type": "string" }, "description": "Company websites.", "nullable": true }, "Emails": { "type": "array", "items": { "type": "string" }, "description": "Company email contacts.", "nullable": true }, "Phones": { "type": "array", "items": { "type": "string" }, "description": "Company phone contacts.", "nullable": true }, "SocialURLs": { "type": "array", "items": { "$ref": "#/components/schemas/SocialURL" }, "description": "Social URLs.", "nullable": true } }, "additionalProperties": false, "description": "Company search result model containing summary information for US API." }, "CompanySuggestion": { "type": "object", "properties": { "HitHorizonsId": { "type": "string", "description": "A unique company identification number assigned by HitHorizons.\r\nThis value is available for company results, null for suggestions.", "nullable": true }, "Name": { "type": "string", "description": "Official name of the company or suggestion value.", "nullable": true }, "PostalCode": { "type": "string", "description": "Postal or zip code for the physical location.\r\nThis value is available for company results, null for suggestions.", "nullable": true }, "CountyDistrict": { "type": "string", "description": "Name of the county or district where the company is located. Generally, in the local language.\r\nThis value is available for company results, null for suggestions.", "nullable": true }, "StateProvince": { "type": "string", "description": "Name of the state or province where the business is located. Generally, in the local language.\r\nThis value is available for company results, null for suggestions.", "nullable": true }, "NationalId": { "type": "string", "description": "National identification number of the company.\r\nThis value is available for company results, null for suggestions.", "nullable": true } }, "additionalProperties": false, "description": "Company suggestion model for US API autocomplete functionality." }, "CompanySuggestionListApiResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Error": { "type": "string", "nullable": true }, "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySuggestion" }, "nullable": true } }, "additionalProperties": false }, "Contacts": { "type": "object", "properties": { "Websites": { "type": "array", "items": { "type": "string" }, "description": "Website addresses / URLs of the company.", "nullable": true }, "Phones": { "type": "array", "items": { "type": "string" }, "description": "Telephone or mobile phone numbers.", "nullable": true }, "Faxes": { "type": "array", "items": { "type": "string" }, "description": "Fax numbers.", "nullable": true }, "Emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses.", "nullable": true }, "SocialURLs": { "type": "array", "items": { "$ref": "#/components/schemas/SocialURL" }, "description": "Social URLs.", "nullable": true } }, "additionalProperties": false, "description": "Represents contact information for a company including phone numbers, emails, websites, and social media URLs." }, "Geolocation": { "type": "object", "properties": { "Longitude": { "type": "number", "description": "Longitude geo positioning coordinate.", "format": "double", "nullable": true }, "Latitude": { "type": "number", "description": "Latitude geo positioning coordinate.", "format": "double", "nullable": true }, "GeoLevel": { "type": "integer", "description": "Level of geocoding. Values: 1 = Country, 2 = State, 3 = City, 4 = PostalCode, 5 = District, 6 = Street, 7 = House, 8 = AddressPoint, 9 = RoofTop (highest accuracy).", "format": "int32", "nullable": true }, "BuildingName": { "type": "string", "description": "Name of the building.", "nullable": true }, "BuildingType": { "type": "string", "description": "Description of the type of building.", "nullable": true }, "BuildingGeom": { "type": "string", "description": "Geocoding of the polygon (building geometry).", "nullable": true }, "BuildingArea": { "type": "integer", "description": "Surface of the building area in square meters.", "format": "int32", "nullable": true }, "LastUpdate": { "type": "string", "description": "Date when the geolocation data was last updated.", "format": "date-time", "nullable": true }, "GeoLevelDescription": { "type": "string", "description": "Description of geocoding level. Values: 1 = Country, 2 = State, 3 = City, 4 = PostalCode, 5 = District, 6 = Street, 7 = House, 8 = AddressPoint, 9 = RoofTop (highest accuracy).", "nullable": true } }, "additionalProperties": false, "description": "Represents geolocation data for a company address including longitude, latitude, geocoding level, and building information.\r\nInherits from horizons.BLL.Model.Uni.Geo which provides Longitude, Latitude, GeoLevel, BuildingName, BuildingType, BuildingGeom, BuildingArea, and LastUpdate." }, "LocActivityCode": { "type": "object", "properties": { "LocalActivityText": { "type": "string", "description": "Description of the local business activity classification.", "nullable": true }, "LocalActivityCode": { "type": "string", "description": "The local industry classification code (e.g., NAICS code for US).", "nullable": true }, "LocalActivityCodeType": { "type": "string", "description": "This indicator identifies which activity code type is provided (e.g., \"112\" for NAICS).", "nullable": true } }, "additionalProperties": false, "description": "Represents a local activity code. For US, this is typically NAICS (North American Industry Classification System)." }, "NACEActivityCode": { "type": "object", "properties": { "NACEText": { "type": "string", "description": "Description of the NACE business classification.", "nullable": true }, "NACECode": { "type": "string", "description": "NACE business classification code.", "nullable": true } }, "additionalProperties": false, "description": "Represents a NACE (Statistical Classification of Economic Activities in the European Community) activity code." }, "ObjectApiResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Error": { "type": "string", "nullable": true }, "Result": { "nullable": true } }, "additionalProperties": false }, "Person": { "type": "object", "properties": { "FullName": { "type": "string", "description": "The full name of the person (e.g., CEOName or executive full name).", "nullable": true }, "Title": { "type": "string", "description": "The title of the person (e.g., CEO, President). May be abbreviated.", "nullable": true }, "FirstName": { "type": "string", "description": "The first name of the person.", "nullable": true }, "LastName": { "type": "string", "description": "The last name of the person.", "nullable": true } }, "additionalProperties": false, "description": "Represents a person associated with a company, such as a CEO or executive." }, "Relation": { "type": "object", "properties": { "RelationType": { "type": "string", "description": "Type of relationship: \"Parent\" (Parent/Headquarter organization), \"Domestic Ultimate\" (highest-level parent within the same country), or \"Global Ultimate\" (highest-level parent worldwide).", "nullable": true }, "HitHorizonsID": { "type": "string", "description": "HitHorizons unique identification number of the related company.", "nullable": true }, "Name": { "type": "string", "description": "Business name of the related company.", "nullable": true }, "Address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false, "description": "Represents a corporate relationship to another company (Parent, Domestic Ultimate, or Global Ultimate)." }, "SICActivityCode": { "type": "object", "properties": { "IndustryText": { "type": "string", "description": "Description of the industry classification.", "nullable": true }, "IndustryCode": { "type": "string", "description": "Industry classification code.", "nullable": true }, "SICText": { "type": "string", "description": "Description of the SIC code.", "nullable": true }, "SICCode": { "type": "string", "description": "Standard Industrial Classification (SIC) code - a 4-digit code used to classify business activities.", "nullable": true } }, "additionalProperties": false, "description": "Represents a Standard Industrial Classification (SIC) activity code with industry information." }, "SocialURL": { "type": "object", "properties": { "Type": { "type": "string", "description": "The type of social media platform. Possible constant values: l (LinkedIn), c (Facebook), x (X).\r\nValues can be found in Codelist.", "nullable": true }, "URL": { "type": "string", "description": "The URL of the company's profile on the specified social media platform.", "nullable": true } }, "additionalProperties": false }, "Stats": { "type": "object", "properties": { "SalesEUR": { "type": "integer", "description": "Sales volume in EUR currency.", "format": "int64", "nullable": true }, "SalesUSD": { "type": "integer", "description": "Sales volume in USD currency.", "format": "int64", "nullable": true }, "SalesLocal": { "type": "integer", "description": "Sales value for the local business in local currency.", "format": "int64", "nullable": true }, "SalesIndicator": { "type": "integer", "description": "Sales volume reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "Currency": { "type": "string", "description": "Currency code indicating which currency the financial figures are represented in.", "nullable": true }, "Employees": { "type": "integer", "description": "Calculated number of employees.", "format": "int32", "nullable": true }, "EmployeesIndicator": { "type": "integer", "description": "Calculated employees reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "EmployeesLocal": { "type": "integer", "description": "The number of employees at this location.", "format": "int32", "nullable": true }, "EmployeesLocalIndicator": { "type": "integer", "description": "Employees here reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "EmployeesTotal": { "type": "integer", "description": "The total number of employees in the business organization.", "format": "int32", "nullable": true }, "EmployeesTotalIndicator": { "type": "integer", "description": "Employees total reliability code. Values: 0 = Accurate, 1 = Low end of a range, 2 = Estimated, 3 = Modeled, 9 = Derived.", "format": "int32", "nullable": true }, "Year": { "type": "integer", "description": "The year for which the historical data applies.", "format": "int32", "nullable": true }, "Other": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional historical data fields including FamilyMembers count and Version identifier.", "nullable": true } }, "additionalProperties": false, "description": "Represents historical financial statistics for a company including sales figures, employee counts, and their reliability codes." }, "StringCodeListValueArrayDictionaryApiResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Error": { "type": "string", "nullable": true }, "Result": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CodeListValue" }, "nullable": true }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Ocp-Apim-Subscription-Key": { "type": "apiKey", "description": "The API subscription key must be present in the request headers", "name": "Ocp-Apim-Subscription-Key", "in": "header" } } }, "security": [ { "Ocp-Apim-Subscription-Key": [ ] } ], "tags": [ { "name": "Company" } ] }