Biz-KYC Company Search API
POST /api/v1/company/biz/page
Request parameters
query
string
Search keyword. At least 3 characters, or 2 characters for Chinese input
- Required:
Yes - Example:
Acme Corp
queryType
integer
Search mode. 1 matches the company name, 2 matches the registration number. Defaults to 1
- Required:
No - Example:
1
countryCode
string
ISO 3166-1 country code used to narrow the search. One country per request; both alpha-2 (SG) and alpha-3 (SGP) are accepted
- Required:
No - Example:
SG
page
integer
Page number. Defaults to 1
- Required:
No - Example:
1
pageSize
integer
Records per page. Defaults to 10
- Required:
No - Example:
10
{
"query": "Acme Corp",
"queryType": 1,
"countryCode": "SG",
"page": 1,
"pageSize": 10
}
curl https://api.tradedata.io/api/v1/company/biz/page \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"query": "Acme Corp", "queryType": 1, "countryCode": "SG", "page": 1, "pageSize": 10}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/company/biz/page",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={
"query": "Acme Corp",
"queryType": 1,
"countryCode": "SG",
"page": 1,
"pageSize": 10,
},
)
print(response.json())
const response = await fetch("https://api.tradedata.io/api/v1/company/biz/page", {
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "Acme Corp",
"queryType": 1,
"countryCode": "SG",
"page": 1,
"pageSize": 10
}),
});
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/company/biz/page");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"query" => "Acme Corp",
"queryType" => 1,
"countryCode" => "SG",
"page" => 1,
"pageSize" => 10
]),
]);
echo curl_exec($ch);
Response parameters
code
int
Status code
- Example:
200
data
array
Result container
data.orgId
string
Company identifier. Pass it to the detail, decision chain and shareholders endpoints
- Example:
5a1b2c3d4e5f000000000001
data.companyName
string
Company name in English
- Example:
Acme Corp
data.companyLocalName
string
Company name in the local language
- Example:
Acme Corp Co., Ltd.
data.countryCode
string
Country code, ISO 3166-1 alpha-2
- Example:
CN
data.countryName
string
Country name
- Example:
China
data.uin
string
Registration number of the company
- Example:
91110000000000000X
data.entityType
string
Legal form of the company
- Example:
Private Limited Company
data.incorporationDate
string
Incorporation date
- Example:
2011-05-18
total
int
Total number of matching records
- Example:
128
isEnd
boolean
Whether this is the last page. Also true when no records are returned
- Example:
false
{
"code": 200,
"success": true,
"data": [
{
"orgId": "5a1b2c3d4e5f000000000001",
"companyName": "Acme Corp",
"companyLocalName": "Acme Corp Co., Ltd.",
"countryCode": "CN",
"countryName": "China",
"uin": "91110000000000000X",
"entityType": "Private Limited Company",
"incorporationDate": "2011-05-18"
}
],
"total": 128,
"isEnd": false,
"msg": "OK"
}
When queryType is 2, records sharing the same company are merged and the result is not paginated.