API

Compliance AML — API Overview

API Overview

Compliance AML provides a versioned REST API (v4) to facilitate integration with customer systems.

Address & Labels API

• /v4/kya/labels — Retrieve structured labels and background information associated with an address
• /v4/kya/risk — Assesses risk of the address itself; returns risk level, risk score, and Risk Factors

Screening APIs

• /v4/kya/screening (Deprecated) — Address screening endpoint for identifying hits against high-risk entities
• /v4/kya/screening_v2 — Comprehensive address screening: covers self risk and further reviews counterparty risk exposure; supports sync and async modes

Transaction API

• /v4/kyt/risk — Transaction risk assessment endpoint for real-time transaction risk control and post-hoc analysis

Key Difference: risk vs screening_v2

kya/risk and kya/screening_v2 are two different capabilities, not a “lighter / fuller” substitute pair. kya/risk evaluates the address itself only and responds fast, making it suitable for first-pass checks; kya/screening_v2 also reviews counterparty risk exposure on top of that, is more comprehensive, and is intended for compliance screening, due diligence, and formal review.

For the full capability comparison, examples, and selection guidance, see risk vs screening_v2.

API Design Highlights

• Structured response formats for easy system parsing
• Emphasis on explainability to support analyst review
• Unified risk model between the web UI and the API