Skip to main content
The Bitrace AML API provides comprehensive blockchain analytics capabilities through two main services:

​
KYA (Know Your Address)

KYA endpoints allow you to analyze blockchain addresses and gather intelligence about entities, risks, and behaviors.

​
Core Endpoints

  • Retrieve Entity - Identify the entity behind an address
  • Retrieve Risk Assessment - Get detailed risk information
  • Retrieve Risk Score - Get numerical system risk scores or custom risk scores
  • Retrieve Entity and Risk - Combined entity and risk data
  • Bulk Operations - Query multiple addresses in a single request

​
Use Cases

  • Compliance Screening: Check addresses before onboarding
  • Risk Assessment: Evaluate counterparty risk
  • Entity Investigation: Understand who owns an address
  • Portfolio Analysis: Analyze multiple addresses at once

​
KYT (Know Your Transaction)

KYT endpoints help you screen transactions for potential risks by analyzing the entire transaction chain.

​
Core Endpoints

  • Retrieve Transaction Risks - Screen transactions for risk indicators
  • Retrieve Custom Risk Score - Calculate custom risk scores based on your rules

​
Use Cases

  • Transaction Monitoring: Real-time risk screening
  • Compliance: Ensure transactions meet compliance requirements
  • Risk Management: Identify potentially risky transactions
  • Investigation: Deep dive into transaction patterns

​
Base URL

All API requests use the following base URL:

​
Authentication

All endpoints require authentication via the X-Access-Key header. See Authentication for details.

​
Response Format

All API responses follow a consistent format:

​
Response Fields

​
boolean
required
Request success or not
​
number
required
  • 1 - success
  • Other numbers, HTTP status code or custom error code, see error codes
​
string
required
SUCCESS or error message
​
object | array
required
The response payload (varies by endpoint) when response 2xx
​
object
The error object when response 4xx or 5xx

​
Versioning

The current API version is v1. All endpoints include /api/v1/ in the path.

​
Rate Limits

API rate limits are based on your subscription plan. Check your dashboard for specific limits.
Explore the endpoints: Select KYA or KYT from the sidebar to see detailed endpoint documentation.