Skip to main content

Address Exposure

Returns category-based exposure for the address used in a manual check.

This endpoint shows how the address is distributed across AML categories (e.g. dex, exchange, fee) based on BitOK’s clustering and attribution.

HTTP Request​

GET /v1/manual-checks/{id}/address-exposure/

Path Parameters​

ParameterTypeRequiredDescription
idstringYesID of the manual check (MANUAL_CHECK).

Response​

A successful response returns HTTP 200 OK with a JSON object describing the address exposure.

Example Response​

{
  "entity_category": null,
  "entity_name": null,
  "exposure": [
    {
      "entity_category": "dex",
      "value_share": 0.6398
    },
    {
      "entity_category": "exchange",
      "value_share": 0.3588
    },
    {
      "entity_category": "fee",
      "value_share": 0.0014
    },
    {
      "entity_category": "dust",
      "value_share": 0.0
    }
  ]
}

Fields​

FieldTypeDescription
entity_categorystring or nullPrimary AML category assigned to the address (e.g. exchange, dex), if available.
entity_namestring or nullHuman-readable name of the entity (e.g. exchange brand), if BitOK knows it.
exposurearray of objectsBreakdown of the address exposure by AML categories.

Each item inside exposure:

FieldTypeDescription
entity_categorystringAML category code (dex, exchange, fee, dust, etc.).
value_sharenumberFraction of total value associated with this category (0–1, e.g. 0.6398).

Try it​

GET/v1/manual-checks/dda28996-5aac-4e6c-9844-e4e658b466ca/address-exposure/
API KEY ID
API KEY SECRET
Path params
id
HTTP Request
Press "Send Request" to generate HTTP request.
HTTP …
{
  // Response will be shown here after the request.
}

---

### 2. `manual-check-transfer-exposure.mdx`

```mdx
---
title: Transfer Exposure
sidebar_label: Transfer Exposure
---

import TryIt from '@site/src/components/TryItHmac';

# Transfer Exposure

Returns **exposure for the transfer** used in a manual check.

This endpoint shows **how the transfer amount is exposed to risky categories**
both via **direct interaction** with an entity and via **indirect flows**.

---

## HTTP Request

`GET /v1/manual-checks/{id}/transfer-exposure/`

---

## Path Parameters

| Parameter | Type   | Required | Description                                   |
|-----------|--------|----------|-----------------------------------------------|
| `id`      | string | Yes      | ID of the manual check (`MANUAL_CHECK`).     |

---

## Response

A successful response returns **HTTP 200 OK** with a JSON object describing the transfer exposure.

### Example Response

```json
{
  "direct_interaction": null,
  "indirect_interaction": [
    {
      "entity_category": "dex",
      "value_share": 0.9994,
      "value_in_fiat": 24388.45814
    },
    {
      "entity_category": "exchange",
      "value_share": 0.0006,
      "value_in_fiat": 14.64186
    },
    {
      "entity_category": "dust",
      "value_share": 0.0,
      "value_in_fiat": 0.0
    }
  ],
  "fiat_currency": "USD"
}

Top-level Fields​

FieldTypeDescription
direct_interactionobject or nullExposure from direct counterparties of the transfer (if a single high-impact entity is detected).
indirect_interactionarray of objectsExposure from indirect flows (upstream / downstream entities linked to this transfer).
fiat_currencystringFiat currency used for value calculation (currently always "USD").

direct_interaction object​

If not null, has the following fields:

FieldTypeDescription
entity_categorystringAML category code of the direct counterparty (e.g. exchange, dex).
entity_namestringHuman-readable entity name, if known.
value_in_fiatnumberAmount of the transfer directly interacting with this entity (in USD).

indirect_interaction items​

Each item inside indirect_interaction:

FieldTypeDescription
entity_categorystringAML category code (dex, exchange, dust, etc.).
value_sharenumberFraction of the transfer value attributed to this category (0–1).
value_in_fiatnumberValue of the transfer attributed to this category in fiat (USD).

Try it​

GET/v1/manual-checks/b2c1c4a1-1956-4cc9-99c8-ee1696c94c49/transfer-exposure/
API KEY ID
API KEY SECRET
Path params
id
HTTP Request
Press "Send Request" to generate HTTP request.
HTTP …
{
  // Response will be shown here after the request.
}