Download OpenAPI specification:Download
DISCLAIMER: This API is in beta stage and may change in the future.
The Company Information API provides comprehensive company information by querying nationally recognized business registers across our primary service regions.
When you perform a search through our API, the system responds with a list of companies that
match the provided query parameters.
The results include each company's legal name and its nationally recognized organization number together with a
lookup_id
that can be used to get more detailed information by calling the Get
Company endpoint.
When looking up a company with the Get Company endpoint, the canonical_id
field of the returned company objects represents the "canonical company ID", which can be used across Two's portfolio
of APIs when a company needs to be referenced.
An example of this is the create
order endpoint, requiring a reference
to the buyer company.
As part of our checkout-api (order creation service), the billing address is a required field in our schema. For merchants who may not initially have the company name, organization number, or billing address for their business buyers, starting with the Search API provides an efficient way for your users to directly identify their business.
Search for companies by name or official regsitry IDs (e.g. organization numbers). This can for instance be
integrated as an auto-complete search in your checkout solution. This endpoints helps users quickly find their
company with a lookup_id
, that can be used in Get Company endpoint to
get the company's canonical ID.
This service enhances user experience by reducing manual input and ensuring that the information provided is accurate and consistent with our API requirements.
Note that this endpoint is optimized for providing quick search results, so the information returned per company is
kept to a minimum.
Additional information can be retrieved by calling the Get Company
endpoint with the lookup_id
obtained from the search.
Successful Response
Validation Error
{- "items": [
- {
- "name": "MONOZUKI AS",
- "country": "US",
- "national_identifier": {
- "type": "NO_BRREG",
- "id": "817352812"
}, - "lookup_id": "NO817352812",
- "highlight": "<mark><b>MONO</b></mark>ZUKI AS"
}
]
}
Get full details on a company, given a company's lookup_id
or canonical_id
.
The result will include company's canonical_id
, which is essential for various operations, such as:
The result includes additional information that cannot be obtained from the Company Search alone.
Successful Response
Company with this ID is not found
Validation Error
{- "name": "MONOZUKI AS",
- "country": "US",
- "national_identifier": {
- "type": "NO_BRREG",
- "id": "817352812"
}, - "identifiers": [
- {
- "type": "NO_BRREG",
- "id": "817352812"
}
], - "addresses": [
- {
- "type": "BUSINESS_ADDRESS",
- "street_address": "Lombard St 10",
- "postal_code": "90210",
- "city": "Beverly Hills",
- "region": "CA",
- "country": "US"
}
], - "canonical_id": "NO817352812"
}