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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.ComplianceApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
ComplianceApi apiInstance = new ComplianceApi();
UUID transactionId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KytScreeningsTransaction result = apiInstance.getKytScreeningStatus(transactionId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKytScreeningStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
transactionId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.ComplianceAPI.GetKytScreeningStatus(ctx).
TransactionId(transactionId).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `ComplianceAPI.GetKytScreeningStatus``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKytScreeningStatus`: KytScreeningsTransaction
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKytScreeningStatus`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.ComplianceApi();
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKytScreeningStatus(transaction_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"review_status": "PendingScreening",
"funds_status": "Frozen"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get KYT screening status
This operation retrieves the current KYT (Know Your Transaction) screening status, including review status and fund disposition status, for a specific transaction.
Use this endpoint to monitor the real-time screening progress for transactions processed through the KYT compliance system.
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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.ComplianceApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
ComplianceApi apiInstance = new ComplianceApi();
UUID transactionId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KytScreeningsTransaction result = apiInstance.getKytScreeningStatus(transactionId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKytScreeningStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
transactionId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.ComplianceAPI.GetKytScreeningStatus(ctx).
TransactionId(transactionId).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `ComplianceAPI.GetKytScreeningStatus``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKytScreeningStatus`: KytScreeningsTransaction
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKytScreeningStatus`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.ComplianceApi();
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKytScreeningStatus(transaction_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"review_status": "PendingScreening",
"funds_status": "Frozen"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.ComplianceApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
ComplianceApi apiInstance = new ComplianceApi();
UUID transactionId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KytScreeningsTransaction result = apiInstance.getKytScreeningStatus(transactionId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKytScreeningStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
transactionId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.ComplianceAPI.GetKytScreeningStatus(ctx).
TransactionId(transactionId).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `ComplianceAPI.GetKytScreeningStatus``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKytScreeningStatus`: KytScreeningsTransaction
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKytScreeningStatus`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.ComplianceApi();
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKytScreeningStatus(transaction_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
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
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.
The UUID of the transaction that was screened.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
The transaction type. Possible values include:
Deposit: A deposit transaction.Withdrawal: A withdrawal transaction.
Deposit, Withdrawal "Deposit"
Review status type, indicating the current stage of the compliance review process.
PendingScreening, Screened, PendingDecision, PendingReview, Approved, Rejected, Unsupported, Bypassed "PendingScreening"
The current status of transaction funds, indicating their disposition state in the compliance system.
Frozen, Refunding, Refunded, RefundFailed, Unfreezing, Unfrozen, UnfreezingFailed, Isolating, Isolated, IsolationFailed, CoboDisposition, Normal "Frozen"
Was this page helpful?
