import cobo_waas2
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)
screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
try:
# Get KYA address screening result
api_response = api_instance.get_kya_screening(screening_id)
print("The response of ComplianceApi->get_kya_screening:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_kya_screening: %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 screeningId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KyaScreeningResult result = apiInstance.getKyaScreening(screeningId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKyaScreening");
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() {
screeningId := "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.GetKyaScreening(ctx, screeningId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ComplianceAPI.GetKyaScreening``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKyaScreening`: KyaScreeningResult
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKyaScreening`: %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 screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKyaScreening(screening_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"screening_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"address": "0x1234567890abcdef1234567890abcdef12345678",
"chain_id": "ETH",
"note": "High-value deposit address",
"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"
}
]
}
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get KYA address screening result
This operation retrieves a specific address screening result by screening_id, including risk assessment information.
import cobo_waas2
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)
screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
try:
# Get KYA address screening result
api_response = api_instance.get_kya_screening(screening_id)
print("The response of ComplianceApi->get_kya_screening:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_kya_screening: %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 screeningId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KyaScreeningResult result = apiInstance.getKyaScreening(screeningId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKyaScreening");
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() {
screeningId := "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.GetKyaScreening(ctx, screeningId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ComplianceAPI.GetKyaScreening``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKyaScreening`: KyaScreeningResult
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKyaScreening`: %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 screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKyaScreening(screening_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"screening_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"address": "0x1234567890abcdef1234567890abcdef12345678",
"chain_id": "ETH",
"note": "High-value deposit address",
"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"
}
]
}
}{
"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.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)
screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
try:
# Get KYA address screening result
api_response = api_instance.get_kya_screening(screening_id)
print("The response of ComplianceApi->get_kya_screening:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_kya_screening: %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 screeningId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
KyaScreeningResult result = apiInstance.getKyaScreening(screeningId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ComplianceApi#getKyaScreening");
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() {
screeningId := "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.GetKyaScreening(ctx, screeningId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ComplianceAPI.GetKyaScreening``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetKyaScreening`: KyaScreeningResult
fmt.Fprintf(os.Stdout, "Response from `ComplianceAPI.GetKyaScreening`: %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 screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getKyaScreening(screening_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.
Path Parameters
The unique identifier (UUID) of the address screening request.
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Response
Successfully retrieved address screening result.
Complete address screening result including risk assessment.
The idempotency identifier from the request, unique within your organization, used for tracking and troubleshooting. Only present in create response.
"scan_eth_addr1_20240721"
The unique system-generated identifier for this screening request (UUID format, fixed 36 characters).
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
The screened blockchain address.
"0x1234567890abcdef1234567890abcdef12345678"
The chain identifier.
"ETH"
The time when the screening request was created, in Unix timestamp format, measured in milliseconds.
1721530814236
The identifier of the user or application that created this screening request.
"user_abc123def456"
The status of the address screening request.
Submitted, Pending, Screened, Failed "Screened"
Optional note for this address screening.
"High-value transaction screening"
Risk assessment information. Only present when status is 'Screened'. Null for other statuses.
Show child attributes
Show child attributes
Was this page helpful?
