Skip to content

Screening result (v2)

GET
/screening/{client_order_id}

Reads an order in any state, in the same shape the order was created with. Reading is free and can be repeated. Replaces GET /apiv2/aml/{order_id}.

An order that belongs to another account answers 404, not 403: otherwise the response code alone would confirm that somebody else's identifier exists.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Path Parameters

client_order_id*

The identifier returned when the order was created.

Type
string
Required
Example"A90D21F68C9AEA2"

Query Parameters

format

Representation of the result, and a property of the request rather than of the order. JSON is the only accepted value; any other returns 4001. The parameter is kept so that adding a second representation later is not a breaking change.

There is no PDF and no Markdown. A report is a rendering of data the response already carries in full, and rendering it on the client side gives that client their own branding, language and layout — which matters most to resellers, for whom a report carrying our name is the wrong document. An unsigned PDF is not evidence for a third party whoever generates it; a verifiable artifact needs a signature or a public verification page, which is a separate feature.

Type
string
Valid values
"json"
Default
"json"

Responses

The order, with the result when there is one.

application/json
JSON
{
  
"schema_version": 2,
  
"order": {
  
  
"client_order_id": "A90D21F68C9AEA2",
  
  
"status": "string",
  
  
"api_version": "string",
  
  
"cache_hit": true,
  
  
"created_at": "string",
  
  
"started_at": "string",
  
  
"completed_at": "string",
  
  
"error": "string",
  
  
"reason": "string",
  
  
"additionalProperties": "string"
  
},
  
"request": {
  
  
"address": "string",
  
  
"network": "string",
  
  
"provider": "string",
  
  
"additionalProperties": "string"
  
},
  
"billing": {
  
  
"charged": true,
  
  
"price_usdt": "0.9634087310611608",
  
  
"base_amount": "0.9634087310611608",
  
  
"markup_amount": "0.9634087310611608",
  
  
"charged_amount": "0.9634087310611608",
  
  
"charged_currency": "TRX",
  
  
"exchange_rate": "string",
  
  
"payment_status": "string",
  
  
"additionalProperties": "string"
  
},
  
"precheck": {
  
  
"activity_checked": true,
  
  
"activity_status": "string",
  
  
"source": "string",
  
  
"additionalProperties": "string"
  
},
  
"check": {
  
  
"provider": "string",
  
  
"provider_check_id": "string",
  
  
"checked_at": "string",
  
  
"status": "string",
  
  
"provider_status": "string",
  
  
"additionalProperties": "string"
  
},
  
"risk": {
  
  
"score": "string",
  
  
"scale": {
  
  
  
"min": 0,
  
  
  
"max": 0
  
  
},
  
  
"level": "string",
  
  
"level_source": "string",
  
  
"provider_level": "string",
  
  
"policy": "netts-risk-v1",
  
  
"by_direction": {
  
  
  
"source": "string",
  
  
  
"destination": "string"
  
  
},
  
  
"additionalProperties": "string"
  
},
  
"sanctions": {
  
  
"self": true,
  
  
"self_entities": [
  
  
],
  
  
"exposure": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"items": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"related": [
  
  
],
  
  
"additionalProperties": "string"
  
},
  
"exposure": [
  
  
{
  
  
  
"category": "string",
  
  
  
"share_fraction": "string",
  
  
  
"direction": "string",
  
  
  
"hops": 0,
  
  
  
"is_screened_address": true,
  
  
  
"entities": [
  
  
  
],
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"rules": [
  
  
{
  
  
  
"name": "string",
  
  
  
"type": "string",
  
  
  
"level": "string",
  
  
  
"score": "string",
  
  
  
"share_fraction": "string",
  
  
  
"category": "string",
  
  
  
"proximity": "string",
  
  
  
"direction": "string",
  
  
  
"detected_at": "string",
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"entities": [
  
  
{
  
  
  
"name": "string",
  
  
  
"category": "string",
  
  
  
"is_vasp": true,
  
  
  
"is_primary": true,
  
  
  
"is_after_sanction_date": true,
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"primary_entity": {
  
  
"name": "string",
  
  
"category": "string",
  
  
"is_vasp": true,
  
  
"is_primary": true,
  
  
"is_after_sanction_date": true,
  
  
"additionalProperties": "string"
  
},
  
"sanctioned_entities": [
  
  
{
  
  
  
"name": "string",
  
  
  
"category": "string",
  
  
  
"is_vasp": true,
  
  
  
"is_primary": true,
  
  
  
"is_after_sanction_date": true,
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"wallet": {
  
  
"inflow_usd": "string",
  
  
"outflow_usd": "string",
  
  
"additionalProperties": "string"
  
},
  
"provider_data": {
  
  
"additionalProperties": "string"
  
},
  
"additionalProperties": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI