Get Invited Users KYC Results

API Description

This interface retrieves the KYC verification results of users directly invited by the currently authenticated affiliate user.

Only directly invited users are included. Users under downstream affiliate users are not included.

If the invited user's KYC level is 1, the result is returned as passed; otherwise, the result is not_passed.

This API supports querying KYC records from up to the past 6 months.

Precautions

1. Request parameters startTime and endTime must use the format yyyy-MM-dd HH:mm:ss.
2. For GET requests, all request parameters must be passed as URL query parameters instead of in the request body.
3. If startTime is not provided, it defaults to the beginning of the current month.
4. If endTime is not provided, it defaults to the end of the current month.
5. Results are sorted in descending order by register_time, then by id for stable sorting.
6. Default pageSize is 100, and the maximum is 1000.

Authentication

This is a private interface and requires authentication. For details on using the RESTful API, refer to Introduction > Authentication & Signature.

Request Method

GET

Endpoint

/api/v3/patener/openapi/v1/partner/invitation/user/kyc/list

Request Parameters

Parameter	Mandatory	Type	Description
startTime	false	String	Start time, formatted as yyyy-MM-dd HH:mm:ss, filtered by registration time. Defaults to the beginning of the current month if not provided.
endTime	false	String	End time, formatted as yyyy-MM-dd HH:mm:ss, filtered by registration time. Defaults to the end of the current month if not provided.
pageNo	false	Integer	Page number. Default: 1.
pageSize	false	Integer	Number of records per page. Default: 100. Maximum: 1000.
uid	false	Long	Filter by specific invited user UID.

Response Parameters

Parameter	Type	Description
data.list[].uid	Long	Invited user UID
data.list[].kycResult	String	KYC result: passed or not_passed
data.total	Long	Total number of records

Request Example

params = {
  "pageNo": 1,
  "pageSize": 100,
  "startTime": "2026-03-01 00:00:00",
  "endTime": "2026-03-31 23:59:59"
}

api_url = "/api/v3/patener/openapi/v1/partner/invitation/user/kyc/list"

method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)  # function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

Response Example

{
  "code": "200",
  "msg": "success",
  "data": {
    "list": [
      {
        "uid": 1116977,
        "kycResult": "passed"
      }
    ],
    "total": 1
  }
}