API DOCUMENTATION

Search Endpoint

Search for Chinese companies by name, English name, or business license number (USCC).

Request

GET /wp-json/chinacheckup/v1/search

Authentication

Method	Example
Header (preferred)	`X-API-Key: your-api-key`
Query parameter	`?token=your-api-key`

Parameters

Parameter	Type	Required	Description
`search_terms`	string	Yes	Company name (Chinese or English) or USCC
`current_page`	integer	No	Page number for pagination (default: 1)

Example Request

GET /wp-json/chinacheckup/v1/search?search_terms=toto&current_page=1
Header: X-API-Key: YOUR_API_KEY

Response

{
  "total_results": 649,
  "current_page": "1",
  "companylist": {
    "9295814": {
      "name": "东陶（中国）有限公司",
      "creditCode": "91110000625910848Y",
      "city": "Beijing",
      "base": "北京",
      "registered_english_name": "Dongtao (China) Co., Ltd.",
      "auto_english_name": "",
      "companyType": 1,
      "companyTypeText": "Company"
    },
    "2344995451": {
      "name": "南京东陶有限公司",
      "creditCode": "91320115608929125H",
      "city": "Nanjing",
      "base": "江苏",
      "registered_english_name": "Nanjing TOTO Co.,Ltd.",
      "auto_english_name": "",
      "companyType": 1,
      "companyTypeText": "Company"
    }
  }
}

Response Fields

Field	Type	Description
`total_results`	integer	Total number of matching companies
`current_page`	string	Current page number
`companylist`	object	Map of company ID → company data

Company Object

Field	Type	Description
`name`	string	Chinese company name
`creditCode`	string	USCC (Unified Social Credit Code) – 18 characters
`city`	string	City name (translated to English)
`base`	string	Province/region (Chinese)
`registered_english_name`	string	Official registered English name (if any)
`auto_english_name`	string	Auto-translated English name (if no official name)
`companyType`	integer	Company type code (1 = Company, 2 = Person)
`companyTypeText`	string	Company type label

Cost

Free (0 credits) – Logged for tracking purposes.

Error Responses

Status	Code	Description
400	`missing_terms`	Missing `search_terms` parameter
400	`no_wallet`	User has no wallet configured
401	`missing_api_key`	No API key provided
403	`invalid_api_key`	Invalid API key

Notes

Returns up to 5 results per page
Use creditCode (USCC) for subsequent getBasic or getFull calls
Companies without a creditCode or city cannot be queried for detailed reports

Get Full Company Data Endpoint

Retrieve comprehensive company information including registration details, business data, judicial records, risk assessment, and AI-powered analysis.

Request

GET /wp-json/chinacheckup/v1/getFull

Authentication

Method	Example
Header (preferred)	`X-API-Key: your-api-key`
Query parameter	`?token=your-api-key`

Parameters

Parameter	Type	Required	Description
`uscc`	string	Yes	Company USCC (Unified Social Credit Code) – 18 characters

Example Request

GET /wp-json/chinacheckup/v1/getFull?uscc=91110000625910848Y
Header: X-API-Key: YOUR_API_KEY

Response

{
  "name": "东陶（中国）有限公司",
  "registered_english_name": "Dongtao (China) Co., Ltd.",
  "creditCode": "91110000625910848Y",
  "regStatus": "Active",
  "regStatus_interpretation": "This status indicates that the company exists and it is in operation.",
  "estiblishTime": "1995-08-18",
  "estiblishTime_formatted": "1995-08-18",
  "company_age_years": "29",
  "percentileScore": "85%",
  "regCapital": "USD 50,000,000",
  "actualCapital": "USD 50,000,000",
  "companyOrgType": "Limited Liability Company (Foreign Investment)",
  "city": "Beijing",
  "base": "Beijing",
  "district": "Chaoyang",
  "regLocation": "No. 123 Example Road, Chaoyang District, Beijing",
  "businessScope": "Manufacturing and sales of sanitary ware...",
  "legalPersonName": "Zhang Wei",
  "legalPersonType": "Person",
  "phoneNumber": "010-12345678",
  "email": "contact@example.com",
  "website": "www.example.com",
  "IndustryMain": "Manufacturing",
  "IndustryBig": "Sanitary Ware",
  "staffNumRange": "1000-4999",
  "socialStaffNum": 2500,
  "analysis": "This is a well-established foreign-invested company...",
  "risk_info": {
    "riskLevel": "low",
    "ownRiskTotal": 0,
    "associatedRiskTotal": 2,
    "categories": [...]
  },
  "staffList": [...],
  "shareHolderList": [...],
  "branchList": [...],
  "lawSuitList": [...],
  "changeList": [...],
  "translation_complete": 1,
  "_credits": 95,
  "_already_purchased": false
}

Response Fields

Basic Information

Field	Type	Description
`name`	string	Chinese company name
`registered_english_name`	string	Official registered English name
`creditCode`	string	USCC (18 characters)
`regStatus`	string	Registration status (e.g., Active, Cancelled)
`regStatus_interpretation`	string	Explanation of the registration status
`estiblishTime`	string	Company establishment date
`company_age_years`	string	Company age in years
`percentileScore`	string	Company reliability score (0-100%)

Financial Information

Field	Type	Description
`regCapital`	string	Registered capital
`actualCapital`	string	Actual paid-in capital

Location & Contact

Field	Type	Description
`city`	string	City (translated)
`base`	string	Province/region (translated)
`district`	string	District
`regLocation`	string	Registered address
`phoneNumber`	string	Contact phone number
`email`	string	Contact email
`website`	string	Company website

Business Information

Field	Type	Description
`companyOrgType`	string	Company organization type
`businessScope`	string	Business scope description
`IndustryMain`	string	Main industry category
`IndustryBig`	string	Industry major category
`IndustryMiddle`	string	Industry middle category
`IndustrySmall`	string	Industry minor category
`staffNumRange`	string	Employee count range
`socialStaffNum`	integer	Social insurance registered employees
`legalPersonName`	string	Legal representative name
`legalPersonType`	string	Legal representative type (Person/Company)

Risk Assessment

Field	Type	Description
`risk_info`	object	Comprehensive risk assessment data
`analysis`	string	AI-generated company analysis

Lists (Arrays)

Field	Type	Description
`staffList`	array	Key personnel and executives
`shareHolderList`	array	Shareholders and ownership structure
`branchList`	array	Branch offices
`investList`	array	Investments in other companies
`lawSuitList`	array	Legal cases and lawsuits
`courtAnnouncementList`	array	Court announcements
`dishonestList`	array	Dishonest debtor records
`abnormalList`	array	Business abnormalities
`changeList`	array	Company changes history
`historyNameList`	array	Previous company names

Metadata

Field	Type	Description
`translation_complete`	integer	Translation status (0 = in progress, 1 = complete)
`_credits`	integer	Your remaining credit balance
`_already_purchased`	boolean	Whether this report was previously purchased

Cost

1 credit per unique company (USCC). Subsequent calls for the same USCC are free.

Error Responses

Status	Code	Description
400	`missing_uscc`	Missing `uscc` parameter
400	`no_wallet`	User has no wallet configured
401	`missing_api_key`	No API key provided
402	`insufficient_credits`	Not enough credits to purchase report
403	`invalid_api_key`	Invalid API key

Notes

Data is cached for 180 days – subsequent calls return cached data without additional API costs
First call may take longer as data is fetched from source
Check translation_complete field – if 0, some fields may still be in Chinese
Use getTranslationStatus to poll for translation completion
The _already_purchased field indicates if this call was charged or free (previously purchased)

Get Translation Status Endpoint

Check the translation status of a company report. Reports are automatically translated from Chinese to English after being requested.

Request

GET /wp-json/chinacheckup/v1/getTranslationStatus

Authentication

Method	Example
Header (preferred)	`X-API-Key: your-api-key`
Query parameter	`?token=your-api-key`

Parameters

Parameter	Type	Required	Description
`uscc`	string	Yes	Company USCC (Unified Social Credit Code)

Example Request

GET /wp-json/chinacheckup/v1/getTranslationStatus?uscc=91110000625910848Y
Header: X-API-Key: YOUR_API_KEY

Response

{
  "uscc": "91110000625910848Y",
  "translation_complete": 1,
  "status": "complete"
}

Response Fields

Field	Type	Description
`uscc`	string	The requested company USCC
`translation_complete`	integer	Translation status code (see below)
`status`	string	Human-readable status

Translation Status Codes

Code	Status	Description
0	`in_progress`	Translation is pending or in progress
1	`complete`	Translation is complete – report is ready
2	`in_progress`	Checked but incomplete – still processing

Cost

Free (0 credits) – No charge for checking translation status.

Error Responses

Status	Code	Description
400	`missing_uscc`	Missing `uscc` parameter
401	`missing_api_key`	No API key provided
403	`invalid_api_key`	Invalid API key

Notes

If the company has never been requested, this endpoint will trigger the initial data fetch
Translation typically completes within a few minutes
Poll this endpoint to check when a report is ready for viewing
Once translation_complete is 1, the report is fully translated and ready

Typical Workflow

Call getFull or getBasic to request a company report
Poll getTranslationStatus every 30-60 seconds
When status is "complete", the translated report is ready
Call getFull again to retrieve the fully translated data