Transaction Monitoring

The Transaction Monitoring APIs allow you to register customers (individuals and companies) for transaction monitoring, track their onboarding status, and manage the compliance pipeline programmatically.

Overview

The Transaction Monitoring integration typically follows this workflow:

1. Register Customers - Use the Add User or Add Company APIs to register individual or corporate customers for transaction monitoring.

2. Track Onboarding - Use the Onboarding Pending API to monitor customers progressing through the onboarding pipeline, filter by verification status, and manage the queue.

3. View Customer Details - Use the Customer Details API to retrieve the full profile of a specific customer, including addresses, bank accounts, and onboarding history.

4. Upload Bank Statements - Use the Add Bank Statement API to upload bank statement files for a customer for compliance and transaction analysis.

5. Review Bank Statement Transactions - Use the Bank Statement Transactions API to retrieve paginated transactions from uploaded bank statements for a specific bank account.

Key Concepts

Customer Types

Transaction Monitoring supports two customer entity types:

Entity Type	User Type	Description
Individual	TMIndividual	A natural person registered for transaction monitoring
Organization	TMLegalEntity	A corporate or legal entity registered for transaction monitoring

Onboarding Statuses

Each customer progresses through the following onboarding statuses:

Status	Description
Pending	Customer created, verification not yet started
NoMailSent	No invitation email has been sent
EmailSent	Verification email has been sent
Invited	Customer has been invited to complete verification
EmailChanged	Customer changed their email address
NotVerified	Customer has not completed verification
LinkExpired	The verification link has expired
Verified	Customer has successfully completed verification

Account Statuses

Status	Description
Active	Customer account is active
Inactive	Customer account is inactive

Risk Statuses

Each customer is assigned a risk level:

Status	Description
NoRisk	No risk detected
Low	Low risk
Medium	Medium risk
High	High risk
Prohibited	Customer is prohibited

Common Use Cases

• Automated Customer Registration — Integrate with your onboarding system to automatically register individuals and companies for transaction monitoring.
• Onboarding Pipeline Management — Track and manage the verification status of all pending customers.
• Compliance Monitoring — Monitor customer risk levels and account statuses for regulatory compliance.
• Bulk Onboarding — Programmatically register multiple customers by iterating through the Add User and Add Company APIs.

Next Steps

Refer to the following documentation to implement the Transaction Monitoring APIs:

• Add User — Register an individual customer for transaction monitoring
• Add Company — Register a corporate entity for transaction monitoring
• Onboarding Pending — Retrieve and filter customers pending onboarding
• Customer Details — Retrieve the full profile of a specific customer
• Add Bank Statement — Upload a bank statement for a customer
• Bank Statement Transactions — Retrieve transactions from bank statements for a bank account