Biz-KYC Company Detail API
POST /api/v1/company/biz/detail
Request parameters
orgId
string
Company identifier returned by the Biz-KYC Company Search API
- Required:
Yes - Example:
5a1b2c3d4e5f000000000001
updateData
boolean
Bypass locally stored data and pull the latest profile from the upstream source
- Required:
No - Example:
false
{
"orgId": "5a1b2c3d4e5f000000000001",
"updateData": false
}
curl https://api.tradedata.io/api/v1/company/biz/detail \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"orgId": "5a1b2c3d4e5f000000000001", "updateData": false}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/company/biz/detail",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={
"orgId": "5a1b2c3d4e5f000000000001",
"updateData": False,
},
)
print(response.json())
const response = await fetch("https://api.tradedata.io/api/v1/company/biz/detail", {
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({
"orgId": "5a1b2c3d4e5f000000000001",
"updateData": false
}),
});
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/company/biz/detail");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"orgId" => "5a1b2c3d4e5f000000000001",
"updateData" => false
]),
]);
echo curl_exec($ch);
Response parameters
code
int
Status code
- Example:
200
data
object
Result container
data.orgId
string
Company identifier
- 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.uinType
string
Type of the registration number
- Example:
Unified Social Credit Code
data.entityType
string
Legal form of the company
- Example:
Private Limited Company
data.incorporationDate
string
Incorporation date
- Example:
2011-05-18
data.representativeName
string
Legal representative of the company
- Example:
John Doe
data.address
string
Registered address
- Example:
123 Example Street, Example City
data.overview
string
Company overview
- Example:
Manufacturer and exporter of industrial components.
data.revenue
int
Annual revenue reported for the company
- Example:
12000000
data.employee
int
Number of employees
- Example:
250
data.primaryIndustry
object
Primary industry, as a code to name mapping
- Example:
{"C35": "Manufacture of electrical machinery"}
data.secondaryIndustry
object
Secondary industry, as a code to name mapping
- Example:
{"G51": "Wholesale trade"}
data.website
string
Company website
- Example:
https://example.com
data.phone
string
Contact phone number
- Example:
+1 555-000-0000
data.email
string
Contact email address
- Example:
[email protected]
data.taxCode
string
Tax identification code
- Example:
91110000000000000X
data.registerPartment
string
Registration authority
- Example:
Example City Administration for Market Regulation
{
"code": 200,
"success": true,
"data": {
"orgId": "5a1b2c3d4e5f000000000001",
"companyName": "Acme Corp",
"companyLocalName": "Acme Corp Co., Ltd.",
"countryCode": "CN",
"countryName": "China",
"uin": "91110000000000000X",
"uinType": "Unified Social Credit Code",
"entityType": "Private Limited Company",
"incorporationDate": "2011-05-18",
"representativeName": "John Doe",
"address": "123 Example Street, Example City",
"overview": "Manufacturer and exporter of industrial components.",
"revenue": 12000000,
"employee": 250,
"primaryIndustry": {
"C35": "Manufacture of electrical machinery"
},
"website": "https://example.com",
"phone": "+1 555-000-0000",
"email": "[email protected]"
},
"msg": "OK"
}
data is null when orgId is missing or no profile exists for the company.