GetBlock AML API: Integration Guide

Authentication

All API requests require an API key passed in the Authorization header as a Bearer token. API keys can be created and managed in the GetBlock Cabinet under API Keys.

Checking an Address

Submit a POST request to /v1/checks with the address, asset, and direction fields. The API returns a check ID immediately. Use the check ID to poll for the result or configure a webhook for asynchronous delivery.

1. 1. Create an API keyOpen API Keys in the GetBlock Cabinet and generate a key with an IP allowlist.
2. 2. Submit a checkSend a POST request to /v1/checks with the address or transaction hash, the asset and the direction. The response contains the check ID.
3. 3. Receive the resultPoll /v1/checks/{id} until the status is completed, or configure a webhook to get the result pushed to your endpoint.

Webhooks

Webhooks provide real-time notifications when a check result is ready, eliminating the need to poll. Configure your webhook URL in the Cabinet settings and we will deliver a signed POST request with the check result payload.