DOCSEARCHbyAlgolia
Submit Docs

Compilot Developer API

website·Indexed 33 days ago

https://docs.compilot.ai

Developer documentation for the Compilot API, featuring endpoints for identity authentication via wallet challenges, dataset management, tag organization, and sig-gating workflows including rules engine scenarios and allowed contract management.

Tokens
89K
Snippets
267
Records
641
Agent score
62%

What's inside Compilot

  1. Overview of ComPilot Dashboard capabilities

    The ComPilot Dashboard is the central control center for compliance processes and the source of truth for compliance data. It provides tools for three primary areas of operation:

    1. Compliance Configuration: Build and maintain workflows and configure the ComPilot Rules Engine.
    2. Developer Integration: Access API keys and development tools required to integrate ComPilot into external applications.
    3. Compliance Management: Perform daily operational tasks including managing customers, monitoring transactions, and remediating compliance alerts.

  2. Overview of ComPilot Workflows

    Workflows in ComPilot are sequences of steps used to orchestrate compliance processes such as customer onboarding and transaction monitoring. Common workflow types include KYC (Know Your Customer), KYB (Know Your Business), Transaction Monitoring (TMS), and Privacy-preserving KYC. Workflows are composed of steps like identity verification, AML screening, duplicate detection, on-chain wallet screening, and risk assessment scenarios. Some steps rely on 'providers'—third-party services (e.g., ComplyAdvantage or ComPilot AML) used to collect or process customer data.

  3. Overview of ComPilot AML Compliance Platform

    ComPilot is an all-in-one platform designed for businesses in the digital asset space to manage AML (Anti-Money Laundering) compliance. It provides a centralized system for securely onboarding, managing, and interacting with customers while serving as a case management tool and a single source of truth for compliance data.

  4. Overview of Privacy-preserving KYC integration

    Integrating ComPilot for privacy-preserving KYC involves a coordinated flow between your client, your server, and the ComPilot platform. The general workflow is as follows:

    1. Session Initiation: Your server uses the JavaScript SDK and a private API key to expose an endpoint that allows users to open authenticated ComPilot sessions.
    2. Client Connection: The front-end SDK (Web or React) calls your server endpoint to establish an authenticated session with ComPilot.
    3. Data Collection: The ComPilot widget collects customer data and transmits it to ComPilot.
    4. Verification: ComPilot forwards data to third-party providers for screening and evaluates results using the ComPilot Rules Engine.
    5. Notification: ComPilot sends updates (event type and customer ID) to your server via webhooks.
    6. Data Retrieval: Your server uses the ComPilot API to fetch specific customer details (e.g., wallet or name) or update records.

  5. Overview of ComPilot developer components

    Developing with ComPilot involves four core components: SDKs for frontend and logic integration, a REST API for backend operations, Webhooks for event-driven architecture, and Smart Contracts for on-chain logic.

  6. Overview of Transaction Monitoring (TM) workflows in ComPilot

    Transaction Monitoring (TM) is a process used to control transactions for individuals or companies to assess associated risks, forming part of the broader Know-Your-Transactions (KYT) concept. In ComPilot, the TM workflow operates by comparing transaction information against pre-configured scenarios and rules.

    There are two primary levels of monitoring:

    1. Basic Monitoring: Used for simple scenarios like threshold monitoring. This does not require third-party providers.
    2. Extended Monitoring: Used for Anti-Money Laundering (AML) and wallet screening. This requires the connection and configuration of third-party providers within the workflow.

  7. Overview of ComPilot KYC workflows

    ComPilot provides Know Your Customer (KYC) workflows to verify customer identities and assess risk. The standard process involves collecting a scan of identity documents and a selfie to validate that the user is the owner of the documents. These workflows are powered by the ComPilot KYC provider, which is built using Sumsub.

  8. Overview of the ComPilot Compliant Airdrop architecture

    The ComPilot Airdrop platform consists of three primary components that work together to manage token distribution to verified users:

    1. Dapp: The user-facing web application used for eligibility verification, wallet connection, and claiming airdrops.
    2. Smart Contracts: A combination of Merkle Drop contracts for optimized token distribution and ComPilot helper contracts that restrict the Claim function to verified users.
    3. Embedded Compliance Workflows: Integrated services for Identity Verification (KYC) and Signature Issuance/Verification to ensure regulatory compliance.

  9. Overview of ComPilot AML

    ComPilot AML is an integrated provider that uses ComplyAdvantage to screen customers for anti-money laundering (AML) activity. Because it is integrated, users do not need a separate account, license, or agreement with ComplyAdvantage. It screens customers against sanctions lists (e.g., OFAC SDN, HM Treasury), Politically Exposed Persons (PEP) classes 1-4, and adverse media (e.g., fraud, narcotics, terrorism). Hits in these categories increase the customer's risk score.

  10. Overview of the ComPilot Rules Engine

    The ComPilot Rules Engine is a no-code tool used to automate risk assessment for onboarding and ongoing compliance. It leverages customer and transaction data to automate decisions regarding:

    • Approving or blocking customers and transactions.
    • Assigning risk levels to customers and transactions.
    • Triggering manual investigations.

    Rules are implemented as 'scenarios' which are attached to workflows and executed every time that workflow is triggered.

  11. Overview of ComPilot KYB integration flow

    Integrating ComPilot into a client-server application involves a multi-step process to verify business identities:

    1. The server uses the JavaScript SDK and a private API key to expose an endpoint for authenticated sessions.
    2. The front end (Web or React SDK) uses this endpoint to open a session.
    3. The ComPilot widget collects customer data and sends it to ComPilot.
    4. ComPilot verifies data via third-party providers and evaluates it using the Rules Engine.
    5. ComPilot sends updates (event type and customer ID) to the server via webhooks.
    6. The server uses the ComPilot API to retrieve detailed customer information or update records.

  12. Overview of ComplyAdvantage AML screening

    The ComplyAdvantage provider enables screening of customers for anti-money laundering (AML) activity. It checks customers against several data sources to determine risk scores:

    • Sanctions, Warnings, and Fitness & Probity: Includes OFAC SDN List, HM Treasury Sanctions List, US Immigration and Customs Wanted, and US System for Award Management Exclusions.
    • Politically Exposed Persons (PEPs): Categorized from Class 1 (heads of state/national governments) to Class 4 (mayors/city council members).
    • Adverse Media: Includes reports on financial AML/CFT, fraud, narcotics, violence, and terrorism.

    If hits are found in these categories, the customer's risk score increases, potentially triggering additional due diligence or blocking of the customer.