Skip to main content
GET
/
compliance
/
kya
/
screenings
import cobo_waas2
from cobo_waas2.models.list_kya_screenings200_response import (
    ListKyaScreenings200Response,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.ComplianceApi(api_client)
    screening_ids = (
        "f47ac10b-58cc-4372-a567-0e02b2c3d479,a1b2c3d4-e5f6-4321-8765-fedcba987654"
    )
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List KYA address screening results
        api_response = api_instance.list_kya_screenings(
            screening_ids=screening_ids, limit=limit, before=before, after=after
        )
        print("The response of ComplianceApi->list_kya_screenings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->list_kya_screenings: %s\n" % e)


{
  "data": [
    {
      "screening_id": "d4e5f6a7-b8c9-4d4e-9f2a-4567890abcde",
      "address": "0x1234567890abcdef1234567890abcdef12345678",
      "chain_id": "ETH",
      "note": "Batch screening for new wallet addresses",
      "created_timestamp": 1721530814236,
      "requested_by": "user_abc123def456",
      "status": "Screened",
      "risk_assessment": {
        "level": "Low",
        "summary": "No significant risks detected",
        "details": [
          {
            "category": "sanctions",
            "exposure": "none"
          },
          {
            "category": "fraud",
            "exposure": "low"
          }
        ]
      }
    },
    {
      "screening_id": "e5f6a7b8-c9d0-4e5f-a02b-567890abcdef",
      "address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      "chain_id": "ETH",
      "created_timestamp": 1721530815456,
      "requested_by": "user_abc123def456",
      "status": "Pending",
      "risk_assessment": null
    }
  ],
  "pagination": {
    "before": "cursor_prev_xyz789",
    "after": "cursor_next_def456",
    "total_count": 125
  }
}
import cobo_waas2
from cobo_waas2.models.list_kya_screenings200_response import (
    ListKyaScreenings200Response,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.ComplianceApi(api_client)
    screening_ids = (
        "f47ac10b-58cc-4372-a567-0e02b2c3d479,a1b2c3d4-e5f6-4321-8765-fedcba987654"
    )
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List KYA address screening results
        api_response = api_instance.list_kya_screenings(
            screening_ids=screening_ids, limit=limit, before=before, after=after
        )
        print("The response of ComplianceApi->list_kya_screenings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->list_kya_screenings: %s\n" % e)

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Query Parameters

​
screening_ids
string

A comma-separated list of screening request IDs to filter specific screening results. Maximum 50 IDs allowed to ensure URL length stays within standard web server limits (typically 8KB).

Each ID must be in standard UUID format (36 characters fixed length).

Example: f47ac10b-58cc-4372-a567-0e02b2c3d479,a1b2c3d4-e5f6-4321-8765-fedcba987654

Comma-separated UUID string (e.g., "uuid1,uuid2,uuid3")

​
limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

Response

Successfully retrieved address screening results with pagination.

​
data
object[]
required
​
pagination
object
required

The pagination information of the returned data.