Skip to content

cp.queryKYC ​

This interface is implemented by the platform application (APP) server and called by the SUD OpenPaaS server.

Query developer/vendor subject KYC. In the reference implementation, subject-level fields match GET /developer/info; richer filing subject/manager fields are in game.queryICP (subject_info / subject_manager).

Invocation method:

  • HTTPS call

HTTPS Call ​

http
POST {query_cp_kyc_webhook}

Request Parameters - Header ​

PropertyTypeDefaultRequiredDescription
AuthorizationstringYesFormat: Bearer {access_token}; subject ID from token

Request Parameters - Body ​

Send an empty JSON object {}.

PropertyTypeDefaultRequiredDescription
(none)object{}YesEmpty JSON {}

Return Value ​

Object ​

Returned JSON packet

PropertyTypeDescription
ret_codeinteger0 success, non-zero failure
ret_msgstring"success" or error reason
dataobjectBusiness body (when ret_code=0)
data.idstringThird-party subject ID
data.subject_namestringSubject name
data.subject_typeinteger0 individual, 1 enterprise
data.usccstringUnified social credit code (enterprise)
data.usernamestringLogin username
data.statusinteger0 disabled, 1 enabled
timestamplongMillisecond timestamp

Valid values of ret_code ​

ValueDescriptionMin version
0Success
40001invalid access_token
40002cp not found

cURL Request ​

bash
curl -X POST \
  {query_cp_kyc_webhook} \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{}'

Success Response ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "id": "a1000000000000000000000000000001",
    "subject_name": "Example Tech Co., Ltd.",
    "subject_type": 1,
    "uscc": "91110000MA01234567",
    "username": "demo_dev",
    "status": 1
  },
  "timestamp": 1719820800000
}

Error Response ​

json
{
  "ret_code": 40001,
  "ret_msg": "invalid access_token"
}