Transfer exposure
Returns exposure information for a specific transfer — the share of funds traced to high-risk categories or entities.
Exposure is calculated based on BitOK’s AML attribution engine and reflects the origin of funds (incoming flow).
HTTP Request
GET /v1/transfers/{id}/exposure/
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Transfer ID (UUID) |
Response
The response contains:
- risk level & score
- categories affecting the exposure
- USD equivalent amount
- breakdown of flows by entity type
Fields
| Field | Type | Description |
|---|---|---|
check_status | string | Exposure calculation status (checking, checked). |
checked_at | string or null | Timestamp when exposure was calculated (ISO 8601). |
risk_level | string | AML risk level (high, medium, low, undefined). |
risk_score | number or null | Numerical risk score. |
fiat_value | number or null | Exposure amount in USD. |
fiat_currency | string | Fiat currency used for exposure (always "USD"). |
categories | array | List of AML categories contributing to exposure. |
Each item inside categories:
| Field | Type | Description |
|---|---|---|
category | string | AML category code (e.g. scam, exchange). |
amount | number | USD amount associated with this category. |
share | number | Percentage of total exposure. |
Example response
{
"check_status": "checked",
"checked_at": "2025-11-20T10:15:22.912384Z",
"risk_level": "medium",
"risk_score": 47,
"fiat_value": 1250.55,
"fiat_currency": "USD",
"categories": [
{
"category": "scam",
"amount": 850.3,
"share": 0.68
},
{
"category": "exchange",
"amount": 400.25,
"share": 0.32
}
]
}
Try it
GET/v1/transfers/{id}/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.
}