Business Identity Data
This page gives an example on how to interact with our API. To learn about all the countries we support and their fields visit our Global Data Coverage Map ↗.
To get the details of a company, caller must provide the country code and company id. Country code is the two character code in ISO-3166 ↗ format. For example, Germany country code will be de
, and Brazil country code will be br
. Company id is the government issued unique identifiers by the local jurisdiction. In some countries, company id is also the tax number, or RUT.
For companies in United States, an additional stateCode
is required in the request input. State code is the two character code in ISO-3166 ↗ format. For example, California state code will be ca
, and Massachusetts state code will be ma
.
Request Format
You can substitute the countryCode
and companyId
in the request.
Property | Type | Description |
---|---|---|
countryCode | enum | Letter country code representing the country of the requested company. |
companyId | string | Identifier of the company following the structure of the registered company. |
stateCode | string | Letter code representing the state of the requested company, if it is located in United States. |
languageCode | string | Letter code representing the language of the response. |
For companies in the United states, the endpoint is: https://api.verifiet.com/v1/company/us/:companyId?stateCode=:stateCode
Response Format
A standard response will contain the basic information of a company, including its name, status, registration date and sometimes registration address.
Property | Type | Description |
---|---|---|
isRegistered | boolean | Boolean indicator for whether the company is registered in a given country. If the companyId or country code is incorrect, this field will be false and other fields will be stubbed with N/A . |
officialName | string | Official name of the corporation in the native alphabet of the country in which the company is registered. |
status | enum | The status of the company. Statuses include ['Active', 'Inactive']. |
registeredAddress | string | Official address of the corporation in the government registry, in the native alphabet of the country. |
registrationDate | date | The date for which the company is first registered with the government. The date is in the format of 'yyyy-mm-dd', e.g. '1970-01-01'. |
Example Request
Optional attributes
- Name
stateCode
- Type
- string
- Description
This attribute is only used for United States (country code: 'us'). It is the two letter state code of the registered company. For example, Massachusetts state code is 'ma'.
Request
curl -G https://api.verifiet.com/v1/company/{countryCode}/{companyId} \
-H "Authorization: Bearer {token}"
You can also make a live test request to our API by going to our Sandbox page.
Response (valid company id)
{
"isRegistered": true,
"status": "Active"
"officialName": "Acme LTD",
"registrationDate": "2019-03-13",
"registeredAddress": "15 Sherbourne Close, Cambridge, United Kingdom, CB4 1RT",
}
Response (non-existent company id)
{
"isRegistered": false,
"status": "N/A",
"officialName": "N/A",
"registrationDate": "N/A",
"registeredAddress": 'N/A',
}
Error Handling
Errors are only returned when the client or server is not operating as expected. Looking up a non-existent company will not lead to errors.
HttpCode | HttpStatus | Error | Retryable | Reasoning |
---|---|---|---|---|
400 | BadRequest | InvalidInputException | NO | The input fields are invalid. For example, the country code provided is incorrect, or company number included invalid characters. |
401 | Unauthorized | NO | The access token provided is invalid. It could have expired or could have been incorrect. | |
429 | Too Many Requests | YES | The client is making more requests than permitted. This request can be retried after waiting for some time. | |
500 | Internal Server Error | InternalFailureException | NO | The service is unable to process the request for unknown reasons. Verifiet's team will be alarmed and investigate the error. |