# Match Companies

Match to HG companies by company name, country code and/or domain URL.

Limited to maximum of 10 companies and sorted by relevance and revenue.

Endpoint: GET /data-api/v1/company/match
Security: authorization

## Query parameters:

  - `company_name` (string)
    Name of the company to search for.
    Example: "Ford Motor Company"

  - `country_code` (string)
    The country where the company's global headquarters resides. Can be a country name or an ISO 3166 alpha-2 code.
    Example: "United States"

  - `domain_name` (string)
    The domain URL associated with the company.
    Example: "ford.com"

  - `limit` (integer)
    The limit of results to be returned. Default of 10.
    Example: 10

## Response 200 fields (application/json):

  - `count` (integer)
    Record count
    Example: 1

  - `data` (array)
    Example: [{"company_id":"6FA567B72D78B7E3EA746973FBBD1D5","company_name":"Adidas North America, Inc.","domain_name":"https://www.adidas.com"}]

  - `data.company_id` (string, required)
    Company ID
    Example: "6FA567B72D78B7E3EA746973FBBD1D5"

  - `data.company_name` (string, required)
    Company name
    Example: "Adidas North America, Inc."

  - `data.domain_name` (string, required)
    Company main domain_name
    Example: "https://www.adidas.com"

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.detail` (string, required)
    Example: "The token provided is not valid"

  - `errors.source` (null)

  - `errors.title` (string, required)
    Example: "Unauthorized"

## Response 422 fields (application/json):

  - `errors` (array, required)

  - `errors.detail` (string, required)
    Example: "null value where string expected"

  - `errors.source` (object, required)

  - `errors.source.pointer` (string, required)
    Example: "/data/attributes/petName"

  - `errors.title` (string, required)
    Example: "Invalid value"