REST API · v1 · Stable

    Embed compliance into every product through the ComplianceSuite REST API.

    The ComplianceSuite API exposes the full platform — KYC, KYB, AML screening, risk scoring, transaction monitoring, and case management — through a single OAuth-secured REST surface.

    OAuth-secured · TLS 1.3
    p99 < 250ms
    99.95% uptime SLA

    Introduction

    Overview

    ComplianceSuite is a modular regtech platform that unifies customer due diligence, screening, monitoring and reporting. The API lets you submit customers, accounts and transactions, trigger risk-scoring or screening on demand, and retrieve verification, screening and case results in real time.

    Submit
    Push customers, officials, accounts and transactions in JSON.
    Trigger
    Run risk scoring or AML screening synchronously or on event.
    Retrieve
    Pull risk scores, screening hits, verification status and cases.
    Subscribe
    Receive outbound webhooks for case updates and alerts.

    Section 2

    Integration architecture

    ComplianceSuite supports both inward integration — where your systems push data into the platform — and outward integration, where the platform pushes events back via webhooks or a Kafka topic.

    Inward · REST
    Synchronous JSON over HTTPS for customer, account and transaction updates.
    Inward · Kafka
    High-throughput event streaming for transaction monitoring at scale.
    Outward · Webhooks
    Signed callbacks for screening hits, case updates and risk-score changes.

    Section 3

    What you can build

    Every workflow available in the ComplianceSuite UI is reachable through the API. The surface is grouped around the things compliance teams do every day.

    KYC & identity verification
    Onboard individuals with document, biometric and data checks.
    KYB & business onboarding
    Verify legal entities, UBOs and corporate structures.
    AML & sanctions screening
    Screen against PEP, sanctions and adverse-media sources.
    Customer & account lifecycle
    Create, update and refresh customers, officials and accounts.
    Transaction monitoring
    Score transactions in real time against your typology library.
    Case & alert workflow
    Triage, assign and close compliance cases programmatically.
    Document upload & evidence
    Attach IDs, contracts and supporting evidence to any record.
    Regulatory reporting
    Generate and submit regulator-ready reports from platform data.
    Webhook subscriptions
    Receive signed event callbacks into your downstream systems.

    Section 4

    Security & reliability

    The API is built on the same platform that powers our regulated customers' production workloads. Every request is authenticated, encrypted in transit, and observable end to end.

    OAuth-secured
    Tenant-scoped tokens with granular permissions.
    TLS 1.3 in transit
    Modern ciphers, HSTS and certificate pinning supported.
    99.95% uptime SLA
    Multi-region active-active deployment.
    Signed webhooks
    HMAC-SHA256 signatures for every outbound event.

    Section 5

    Full technical documentation

    Endpoint reference, payload schemas, authentication setup, SDK packages and step-by-step integration guides live in the ComplianceSuite developer portal. Access is provisioned by our Tech Support team for approved clients and partners.

    Gated developer portal

    Hosted on ReadMe.io and continuously updated as the platform evolves. You will receive portal credentials, sandbox access and SDK download links once your account is approved.

    Endpoint reference & payload schemas
    Authentication and credential management
    Official SDKs for Node.js, Python, Java and .NET
    Sandbox environment with non-production data
    Webhook event catalogue and signing guide
    Step-by-step integration playbooks

    FAQ

    Frequently asked

    What does the ComplianceSuite REST API do?
    It exposes the full platform — onboarding, screening, risk scoring, transaction monitoring, case management and reporting — so you can automate any workflow you can do in the UI.
    How do I authenticate?
    Access is secured through industry-standard, token-based authentication. Credentials are issued by our Tech Support team during onboarding, and step-by-step setup is documented in the gated developer portal you receive with your access.
    Are there rate limits?
    Yes. Sensible limits are applied to keep the platform fast and reliable for everyone, and they are tuned per tenant based on your usage profile. Specific thresholds are shared with your credentials and can be adjusted for high-volume customers on request.
    Do you provide webhooks for events?
    Yes. Signed webhooks notify your systems on screening hits, risk-score changes, case transitions, document expirations and report submissions. The full event catalogue is in the gated developer portal.
    Is there a sandbox environment?
    Yes. Every customer and partner is provisioned with an isolated, non-production environment that mirrors live behaviour, so you can build and test integrations safely before going live. Access is included with your developer credentials.
    Are SDKs available?
    Yes. Official SDKs are maintained for the most common server-side technology stacks to accelerate integration. Supported languages, packages and installation instructions are provided through the gated developer portal.

    Ready to integrate?

    Request developer credentials and our integration engineers will walk you through the portal, sandbox and SDK setup.

    Request API access