Company API (0.9.0)

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.

How It Works

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.

Referencing a company across Two's APIs

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.

Importance in the Checkout API

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.

Company

Company Search

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.

Request

query Parameters

	CompanyType (string) or Company Type (null) (Company Type) The type of company to search for. It is only available in Norway for now.
country required	string (Country) = 2 characters The country to search in (as alpha-2 ISO 316)
limit	integer (Limit) [ 1 .. 100 ] Default: 15
q required	string (Q) Search query

Responses

200

Successful Response

400

Bad Request

422

Validation Error

get/company

Request samples

curl
Python
JavaScript
Node.js

Response samples

application/json

{"items": [{"name": "MONOZUKI AS",
"country": "US",
"national_identifier": {"type": "AT_FN",
"id": "817352812"
},
"company_type": "GOVERNMENT",
"lookup_id": "NO817352812",
"highlight": "<mark><b>MONO</b></mark>ZUKI AS"
}
]
}

Get Company

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:

Order Creation (Core Flow): Simplify the process by automatically filling in required details.
Trade Account Onboarding: Streamline the onboarding process with accurate company data. Note that the onboarding service is optional and not required for order creation.

The result includes additional information that cannot be obtained from the Company Search alone.

Securityapi-key

Request

path Parameters

required

string (Id)

Responses

200

Successful Response

400

Bad Request

404

Not Found

422

Validation Error

get/company/{id}

Request samples

curl
Python
JavaScript
Node.js

Response samples

application/json

{"name": "MONOZUKI AS",
"country": "US",
"national_identifier": {"type": "AT_FN",
"id": "817352812"
},
"company_type": "GOVERNMENT",
"identifiers": [{"type": "AT_FN",
"id": "817352812"
}
],
"addresses": [{"type": "BUSINESS_ADDRESS",
"street_address": "Lombard St 10",
"postal_code": "90210",
"city": "Beverly Hills",
"region": "CA",
"country": "US"
}
],
"canonical_id": "NO817352812"
}

Get Company Branches

** This endpoint is only supported in Norway (NO) for now. **

Get all branches of a company, given a company's canonical_id, which you can get from Get Company .

Request

path Parameters

canonical_id

required

string (Canonical Id)

query Parameters

limit

integer (Limit) [ 1 .. 100 ]

Default: 15

Responses

200

Successful Response

400

Bad Request

404

Not Found

422

Unprocessable Entity

get/company/{canonical_id}/branches

Request samples

curl
Python
JavaScript
Node.js

Response samples

application/json

{"items": [{"name": "MONOZUKI AS",
"country": "US",
"national_identifier": {"type": "AT_FN",
"id": "817352812"
}
}
]
}