kya/screening_v2/list

Summary

The /kya/screening_v2/list endpoint lets you retrieve a list of all screening records under organization (org) or API Key (key).

Request

• HTTP Method: GET
• Endpoint Path: /kya/screening_v2/list
• Query Parameters:

Parameter	Type	Required	Description	Example
scope	String	Yes	Scope of the screening records	key, org

Response

Field	Type	Presence	Description
id	String	Always	Unique identifier for the specific screening record.
chain	String	Always	The blockchain network identifier (e.g., eth, btc).
address	String	Always	The wallet address that was screened.
rule_set_id	String	Always	Identifier of the compliance rule set applied to this task.
status	String	Always	Current state of the task (e.g., SUCCESS, FAILED, PENDING).
retry_count	Integer	Always	Number of times the system re-attempted the task.
created_at	String	Always	ISO 8601 timestamp of when the record was created.
updated_at	String	Always	ISO 8601 timestamp of the last update to this record.
started_at	String	Conditional (Present if started)	ISO 8601 timestamp of when the analysis engine began.
finished_at	String	Conditional (Present if finished)	ISO 8601 timestamp of when the analysis was completed.
api_key	String	Always	The specific API key that triggered the screening.
org_id	String	Always	The organization identifier the record belongs to.

Example Code

Request

curl -X GET "https://api.compliance.certik.com/v4/kya/screening_v2/list?scope=org" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Response

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "69afe0063f39a790d6977772",
      "chain": "eth",
      "address": "0x2782b70De7B99cEc2AD56Ff67b14fA269945Ce4b",
      "rule_set_id": "standard-mode-rule-set",
      "status": "SUCCESS",
      "retry_count": 0,
      "created_at": "2026-03-10T09:10:30.374Z",
      "updated_at": "2026-03-10T09:10:35.529Z",
      "started_at": "2026-03-10T09:10:34.927Z",
      "finished_at": "2026-03-10T09:10:35.529Z",
      "api_key": "YOUR_API_KEY",
      "org_id": "fireworks"
    },
    {
      "...": "omitted additional items"
    }
  ]
}

Note: The response above is abbreviated and only shows representative items.

Try It