Skip to main content
POST
/
compliance
/
kya
/
screenings
import cobo_waas2
from cobo_waas2.models.create_kya_screenings_body import CreateKyaScreeningsBody
from cobo_waas2.models.kya_screening_result import KyaScreeningResult
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)
    create_kya_screenings_body = cobo_waas2.CreateKyaScreeningsBody(
        screenings=[
            cobo_waas2.KyaScreeningRequest(
                request_id="scan_eth_addr1_20240721",
                address="0x1234567890abcdef1234567890abcdef12345678",
                chain_id="ETH",
            )
        ]
    )

    try:
        # Create KYA address screening requests
        api_response = api_instance.create_kya_screenings(
            create_kya_screenings_body=create_kya_screenings_body
        )
        print("The response of ComplianceApi->create_kya_screenings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->create_kya_screenings: %s\n" % e)


[
  {
    "request_id": "scan_eth_addr1_20240721",
    "screening_id": "a1b2c3d4-e5f6-4a1b-8c9d-1234567890ab",
    "address": "0x1234567890abcdef1234567890abcdef12345678",
    "chain_id": "ETH",
    "note": "High-value deposit address",
    "status": "Submitted",
    "created_timestamp": 1721530814236,
    "requested_by": "user_abc123def456",
    "risk_assessment": null
  },
  {
    "request_id": "scan_eth_addr2_20240721",
    "screening_id": "b2c3d4e5-f6a7-4b2c-9d1e-234567890abc",
    "address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
    "chain_id": "ETH",
    "note": "Regular deposit address",
    "status": "Screened",
    "created_timestamp": 1721530814237,
    "requested_by": "user_abc123def456",
    "risk_assessment": {
      "level": "Low",
      "summary": "No significant risks detected"
    }
  },
  {
    "request_id": "scan_btc_addr1_20240721",
    "screening_id": "c3d4e5f6-a7b8-4c3d-9e1f-34567890abcd",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "chain_id": "BTC",
    "note": "Withdrawal address",
    "status": "Submitted",
    "created_timestamp": 1721530814238,
    "requested_by": "user_abc123def456",
    "risk_assessment": null
  }
]
import cobo_waas2
from cobo_waas2.models.create_kya_screenings_body import CreateKyaScreeningsBody
from cobo_waas2.models.kya_screening_result import KyaScreeningResult
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)
    create_kya_screenings_body = cobo_waas2.CreateKyaScreeningsBody(
        screenings=[
            cobo_waas2.KyaScreeningRequest(
                request_id="scan_eth_addr1_20240721",
                address="0x1234567890abcdef1234567890abcdef12345678",
                chain_id="ETH",
            )
        ]
    )

    try:
        # Create KYA address screening requests
        api_response = api_instance.create_kya_screenings(
            create_kya_screenings_body=create_kya_screenings_body
        )
        print("The response of ComplianceApi->create_kya_screenings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->create_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.

Body

application/json

The request body to create KYA address screening requests.

Information about address screening requests.

​
screenings
object[]
required

List of address screening requests. Maximum 50 addresses per call.

Required array length: 1 - 50 elements

Response

Successfully created address screening requests.

​
request_id
string
required

The idempotency identifier from the request, unique within your organization, used for tracking and troubleshooting. Only present in create response.

Example:

"scan_eth_addr1_20240721"

​
screening_id
string<uuid>
required

The unique system-generated identifier for this screening request (UUID format, fixed 36 characters).

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
address
string
required

The screened blockchain address.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
chain_id
string
required

The chain identifier.

Example:

"ETH"

​
created_timestamp
integer<int64>
required

The time when the screening request was created, in Unix timestamp format, measured in milliseconds.

Example:

1721530814236

​
requested_by
string
required

The identifier of the user or application that created this screening request.

Example:

"user_abc123def456"

​
status
enum<string>
required

The status of the address screening request.

Available options:
Submitted,
Pending,
Screened,
Failed
Example:

"Screened"

​
note
string

Optional note for this address screening.

Example:

"High-value transaction screening"

​
risk_assessment
object

Risk assessment information. Only present when status is 'Screened'. Null for other statuses.