First Steps

Quick AML Check Guide

This guide shows a minimal end-to-end flow for checking a transfer in BitOK and downloading a PDF report:

1. Check that the token and network are supported in BitOK.
2. Create a manual transfer check.
3. Poll the manual check status and inspect risk results.
4. Download a PDF report for the completed check.

1

Verify token support

First, verify that the network and token of your transfer are supported by BitOK using /v1/basics/tokens/. You can filter by network and token_id (contract address or native).

Make sure that the check_levels.transfer_exposure and check_levels.transfer_counterparty are not none.

GET/v1/basics/tokens/

API KEY ID

API KEY SECRET

Query params (JSON)

{ "network": "ETH", "token_id": "native" }

HTTP Request

Press "Send Request" to generate HTTP request.

HTTP …
{
  // Response will be shown here after the request.
}

2

Create a manual transfer check

Then create a manual AML/KYT check for the transfer using /v1/manual-checks/check-transfer/. Pass the network, token, transaction hash and direction.

The response will contain a manual check object with its own id. You will use this ID in the following steps.

POST/v1/manual-checks/check-transfer/

API KEY ID

API KEY SECRET

Body (JSON)

{ "network": "ETH", "token_id": "native", "tx_hash": "0x5056ad9a11196c31d3970255e1a82ef919cebda8bd6ab8eb09f5513a3fbde1fb", "output_address": "0xYourCustomerAddress", "direction": "incoming", "risk_model": null }

HTTP Request

Press "Send Request" to generate HTTP request.

HTTP …
{
  // Response will be shown here after the request.
}

3

Poll manual check status

Use /v1/manual-checks/{id}/ to monitor the status of the created manual check. Wait until check_status becomes checked.

The response contains the overall AML decision: risk_level, risk_score, and basic transfer data.

GET/v1/manual-checks/YOUR_MANUAL_CHECK_ID/

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.
}

4

Download the PDF report

When the manual check is completed, you can download a PDF report using /v1/manual-checks/{id}/pdf-report/ or /v1/manual-checks/{id}/pdf-report-without-risks/ for a shortened version.

The BitOK documentation UI cannot preview PDF files directly, but when you press Send Request in the widget below, your browser will prompt you to download the generated PDF file.

GET/v1/manual-checks/YOUR_MANUAL_CHECK_ID/pdf-report/

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.
}