Skip to main content
GET
/
compliance
/
kyt
/
screenings
/
status
import cobo_waas2
from cobo_waas2.models.kyt_screenings_transaction import KytScreeningsTransaction
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)
    transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"

    try:
        # Get KYT screening status
        api_response = api_instance.get_kyt_screening_status(transaction_id)
        print("The response of ComplianceApi->get_kyt_screening_status:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling ComplianceApi->get_kyt_screening_status: %s\n" % e
        )


{
  "transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "review_status": "PendingScreening",
  "funds_status": "Frozen"
}
import cobo_waas2
from cobo_waas2.models.kyt_screenings_transaction import KytScreeningsTransaction
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)
    transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"

    try:
        # Get KYT screening status
        api_response = api_instance.get_kyt_screening_status(transaction_id)
        print("The response of ComplianceApi->get_kyt_screening_status:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling ComplianceApi->get_kyt_screening_status: %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

​
transaction_id
string<uuid>
required

The unique identifier (UUID) of the transaction to retrieve KYT screening status information for.

Response

Successfully retrieved KYT screening information.

KYT screening status information including the transaction’s review status and fund status.

​
transaction_id
string<uuid>
required

The UUID of the transaction that was screened.

Example:

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

​
transaction_type
enum<string>
required

The transaction type. Possible values include:

  • Deposit: A deposit transaction.
  • Withdrawal: A withdrawal transaction.
Available options:
Deposit,
Withdrawal
Example:

"Deposit"

​
review_status
enum<string>
required

Review status type, indicating the current stage of the compliance review process.

Available options:
PendingScreening,
Screened,
PendingDecision,
PendingReview,
Approved,
Rejected,
Unsupported,
Bypassed
Example:

"PendingScreening"

​
funds_status
enum<string>
required

The current status of transaction funds, indicating their disposition state in the compliance system.

Available options:
Frozen,
Refunding,
Refunded,
RefundFailed,
Unfreezing,
Unfrozen,
UnfreezingFailed,
Isolating,
Isolated,
IsolationFailed,
CoboDisposition,
Normal
Example:

"Frozen"