Skip to main content

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

ParameterTypeRequiredDescription
idstringYesTransfer ID (UUID)

Response

The response contains:

  • risk level & score
  • categories affecting the exposure
  • USD equivalent amount
  • breakdown of flows by entity type

Fields

FieldTypeDescription
check_statusstringExposure calculation status (checking, checked).
checked_atstring or nullTimestamp when exposure was calculated (ISO 8601).
risk_levelstringAML risk level (high, medium, low, undefined).
risk_scorenumber or nullNumerical risk score.
fiat_valuenumber or nullExposure amount in USD.
fiat_currencystringFiat currency used for exposure (always "USD").
categoriesarrayList of AML categories contributing to exposure.

Each item inside categories:

FieldTypeDescription
categorystringAML category code (e.g. scam, exchange).
amountnumberUSD amount associated with this category.
sharenumberPercentage 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.
}