Overview

The Transaction Screening API is a high-performance AML (Anti-Money Laundering) and CTF (Counter-Terrorist Financing) solution. It is designed to analyze financial operations in real-time, combining traditional FIAT data with advanced Blockchain intelligence (KYT - Know Your Transaction).

This API allows you to mitigate risk by screening both the financial details and the entities (Senders and Beneficiaries) involved in a transaction.

Key Capabilities

Multi-Asset Support: Seamless analysis for both FIAT currencies and Cryptocurrencies.

Entity Screening: Real-time verification of Senders and Beneficiaries against global sanction lists (OFAC, PEP, etc.).

Blockchain Intelligence: Advanced wallet analysis to detect suspicious patterns on-chain.

Automated Compliance: Instant risk scoring to accelerate decision-making processes.

Integration Workflows

Rillis offers two ways to manage your compliance flow:

All-in-One Transaction: You can submit a full transaction payload including all remitter and beneficiary details in a single request. Rillis will automatically create and analyze the entities internally.

Modular Entity Screening: You can use our standalone Entity Endpoints to analyze a Remitter or Beneficiary before performing a transaction. This is ideal for onboarding processes or periodic KYB/KYC refreshes.

Participants & Entity Classification

Every transaction involves two main participants: the Remitter (Sender) and the Beneficiary (Receiver). Our API uses a polymorphic structure based on the entity_type field:

1. Natural Person (`PERSON`)

Standard KYC data for individuals, including full names, identification numbers, and PEP (Politically Exposed Person) status.

2. Legal Person (`COMPANY`)

Comprehensive KYB data. This includes:

Company Data: Basic registration and constitution details.

Legal Representatives: Information on the individuals authorized to act on behalf of the company.

Ultimate Beneficial Owners (UBOs): Analysis of individuals with significant ownership or control (final_beneficiaries).

3. Cryptocurrency Wallet (`CRYPTO`)

Blockchain-specific identification, requiring the address, network, and asset (e.g., BTC on Bitcoin Network).

API Endpoints

1. Transaction Management

Submit Transaction for Analysis

Register a transaction and initiate the screening process. This endpoint evaluates the financial data and the risk profile of the involved parties.

Endpoint: POST /api/v1/verification/send

Method: POST

Documentation: View POST Reference

Example Payload (Crypto Transaction):

{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "transaction": {
        "external_transaction_id": "YOUR_TRANSACTION_ID",
        "transaction_type": "CRYPTO",
        "sending_dollar_amount": 150.00,
        "asset": "BTC",
        "network": "Bitcoin",
        "receiving_wallet": "bc1q8m4h4d92apd0s8jmwx9ywy6eamh9rl58n2a6sm"
    },
    "remitter": {
        "external_id": "YOUR_REMITTER_ID",
        "entity_type": "PERSON",
        "natural_person": {
            "full_name": "JOHN DOE",
            "nationality": "USA",
            "document_type": "ID-CARD",
            "document_number": "123456789"
        }
    },
    "beneficiary": {
        "external_id": "YOUR_BENEFICIARY_ID",
        "entity_type": "CRYPTO",
        "crypto": {
            "address": "bc1q8m4h4d92apd0s8jmwx9ywy6eamh9rl58n2a6sm",
            "network": "Bitcoin",
            "asset": "BTC"
        }
    }
}

Check Transaction Status

Retrieve the current status and detailed analysis results using the transaction identifier.

Endpoint: GET /api/v1/verification/get

Method: GET

Authentication: Requires client_id and client_secret.

Documentation: View GET Reference

2. Entity Management (Standalone)

These endpoints allow you to create and screen participants independently. They use the same data structures as the transaction endpoint.

Create Remitter

Endpoint: POST /api/v1/verification/create-remitter

Method: POST

Authentication: Requires client_id and client_secret.

Documentation: View GET Reference

Example (Company):

{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "binding_list": true,
    "external_id": "YOUR_COMPANY_ID",
    "entity_type": "COMPANY",
    "legal_person": {
        "company_data": {
            "company_name": "ACME CORP",
            "country_constitution": "USA",
            "email": "compliance@acme.com"
        }
    }
}

Create Beneficiary

Endpoint: POST /api/v1/verification/create-beneficiary

Method: POST

Authentication: Requires client_id and client_secret.

Documentation: View GET Reference

Example (Crypto):

{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "binding_list": true,
    "external_id": "beneficiary-wallet-001",
    "entity_type": "CRYPTO",
    "crypto": {
        "address": "bc1q8m4h4d92apd0s8jmwx9ywy6eamh9rl58n2a6sm",
        "network": "BITCOIN",
        "asset": "BTC"
    }
}

Entity Classification (Polymorphism)

The API utilizes a polymorphic data structure for transaction participants. This means the JSON object required for remitter and beneficiary changes dynamically based on the entity_type you specify.

Entity Type	Required JSON Object	Description & Use Case	Key Attributes
`PERSON`	`natural_person`	Individuals / Retail Customers. Used for standard KYC screening of natural persons.	`full_name`, `document_number`, `nationality`, `birth_date`
`COMPANY`	`legal_person`	Legal Entities / B2B. Used for KYB (Know Your Business). Requires details on the company structure and representatives.	`company_name`, `tax_id`, `country_constitution`, `final_beneficiaries` (UBOs)
`CRYPTO`	`crypto`	Unhosted Wallets. Used when the counterparty is a blockchain address without associated PII (Personally Identifiable Information).	`address`, `network`, `asset`

Transaction Types

Fiat Transactions

Operations involving traditional currencies (USD, EUR, CLP, etc.).
Required Core Fields: transaction_type: "FIAT", sending_amount, sending_currency, receiving_amount, and receiving_currency.

Cryptocurrency Transactions

Operations involving on-chain assets.
Required Core Fields: transaction_type: "CRYPTO", network, asset, sending_dollar_amount, and receiving_wallet.

Transaction Analysis Process

When a transaction is submitted for analysis, Rillis performs the following steps:

Initial Validation: Checks if all required fields are provided and valid.

Risk Assessment: Analyzes the transaction for potential risks based on various factors.

Entity Verification: Verifies the entities involved in the transaction.

Wallet Analysis: For cryptocurrency transactions, analyzes the wallets for suspicious activities.

Compliance Check: Ensures the transaction complies with relevant regulations.

Result Determination: Determines the final result of the analysis.

The analysis process typically takes approximately 30 seconds to complete.

Transaction Statuses

Status	Description	Action Required
`PROGRESS`	The transaction is currently under analysis.	Wait for Webhook or poll again.
`COMPLETED`	Analysis finished. No high risks detected.	Proceed with the transaction.
`REJECTED`	High risk or Sanction hit detected.	Stop the transaction immediately.
`EVALUATION`	Manual review required by a Compliance Officer.	Check the dashboard for details.
`COMPLIANCE`	Transaction exceeds predefined company thresholds.	Review internal limit policies.
`CANCELLED`	The operation was cancelled by the operator.	No further action.

Webhook Notifications

Rillis can send webhook notifications to your application when the transaction status changes. To receive these notifications, you need to configure a webhook URL in your Rillis account.

For more information about webhook notifications, see the Webhook documentation.

Best Practices

Unique Transaction IDs: Always use unique client_transaction_id values for each transaction.

Error Handling: Implement proper error handling to manage API responses.

Webhook Integration: Configure webhook notifications to receive real-time updates about transaction status changes.

Retry Logic: Implement retry logic for API calls to handle temporary network issues.

Logging: Log all API requests and responses for debugging and auditing purposes.

Available Cryptocurrencies

For a list of supported cryptocurrencies and networks, refer to the Cryptocurrencies API.

Overview

Key Capabilities#

Integration Workflows#

Participants & Entity Classification#

1. Natural Person (PERSON)#

2. Legal Person (COMPANY)#

3. Cryptocurrency Wallet (CRYPTO)#

API Endpoints#

1. Transaction Management#

Submit Transaction for Analysis#

Check Transaction Status#

2. Entity Management (Standalone)#

Create Remitter#

Create Beneficiary#

Entity Classification (Polymorphism)#

Transaction Types#

Fiat Transactions#

Cryptocurrency Transactions#

Transaction Analysis Process#

Transaction Statuses#

Webhook Notifications#

Best Practices#

Available Cryptocurrencies#

Key Capabilities

Integration Workflows

Participants & Entity Classification

1. Natural Person (`PERSON`)

2. Legal Person (`COMPANY`)

3. Cryptocurrency Wallet (`CRYPTO`)

API Endpoints

1. Transaction Management

Submit Transaction for Analysis

Check Transaction Status

2. Entity Management (Standalone)

Create Remitter

Create Beneficiary

Entity Classification (Polymorphism)

Transaction Types

Fiat Transactions

Cryptocurrency Transactions

Transaction Analysis Process

Transaction Statuses

Webhook Notifications

Best Practices

Available Cryptocurrencies