Alerts

Suspicious transaction activity alerts requiring investigation.

Field	Key	Data Type	Required	Max Length	Description
Alert ID	`alert_id`	string	Yes	36	Unique identifier for each alert in your system
Entity ID List	`entity_id_list`	array[string]	Yes	-	List of associated Entity IDs that must map to previously submitted entities
Flagged Transaction ID List	`flagged_transaction_id_list`	array[string]	Yes	-	Array of Transaction IDs flagged by this alert (must map to submitted transactions)
Alert Type	`source`	string enum value	Yes	-	`TM` (Transaction Monitoring) or `BM` (Blockchain Monitoring)
Alert Title	`title`	string	Yes	-	Alert title displayed in Rose UI for reference
Alert Description	`description`	string	No	-	Free-form description for Rose analysis
Status	`status`	string enum value	Yes	-	`OPEN` or `CLOSED` (Rose only analyzes OPEN alerts)
Created At	`created_at`	string	Yes	-	ISO8601 datetime when alert was created
Rule Title	`rule_title`	string	Yes	-	Title of the rule that triggered the alert
Disposition Status	`disposition_status`	string enum value	No	-	`UNDER_INVESTIGATION`, `PENDING_INFO`, `ESCALATED`, `MONITORING`, `SUSPICIOUS_CONFIRMED`, `STR_FILED`, `CLOSED`, `CLEARED`, `NON_REFERRAL`, `REOPENED`
Disposition Notes	`disposition_notes`	string	No	-	Free text for disposition narratives and notes
Dispositioned At	`dispositioned_at`	string	No	-	ISO8601 datetime when disposition was set
Dispositioned By	`dispositioned_by`	string	No	-	Email address of team member who changed disposition
Start Date	`start_date`	string	No	-	ISO8601 datetime of first flagged transaction
End Date	`end_date`	string	No	-	ISO8601 datetime of last flagged transaction

Entities

Individual persons and business entities involved in transactions.

Field	Key	Data Type	Required	Max Length	Description
Entity ID	`entity_id`	string	Yes	36	Unique identifier for each entity in your system
Type	`type`	string enum value	Yes	-	`INDIVIDUAL` or `BUSINESS`
Date of Birth	`dob`	string	No	-	ISO8601 date format `YYYY-MM-DD`
Corporate Tax ID	`corporate_tax_id`	string	No	-	Corporate identifier (EIN, FEIN, BN, UTR, CRN, etc.)
Corporate Tax ID Type	`corporate_tax_id_type`	string	No	-	Type of tax ID (EIN, FEIN, BN, UTR, CRN, Steuernummer, etc.)
Emails	`emails`	array[string]	No	-	List of email addresses
Gender	`gender`	string enum value	No	-	`MALE` or `FEMALE`
Occupation	`occupation`	string	No	-	Individual's occupation
Name	`name`	string	No	-	Legal name of entity
Account Holder Name	`account_holder_name`	string	No	-	Name of person associated with business account
IP Addresses	`ip_addresses`	array[string]	No	-	IPv4 or IPv6 addresses
Phone Numbers	`phone_numbers`	array[string]	No	-	Phone numbers in E.164 format
Registered At	`registered_at`	string	No	-	ISO8601 datetime when entity registered
Mailing Street Address	`mailing_street_address`	string	No	-	Street address
Mailing City	`mailing_city`	string	No	-	City/locality
Mailing State	`mailing_state`	string	No	-	State/province/region
Mailing Postal Code	`mailing_postal_code`	string	No	-	Postal/zip code
Mailing Country	`mailing_country`	string	No	-	ISO 3166 alpha-2 country code

Transaction API Data Model

Transaction (Main Model)

Field	Key	Data Type	Required	Max Length	Description
Transaction ID	transaction_id	string	Yes	255	Unique identifier in your system
Type	type	Transaction Types(ENUM)	No	-	Transaction type (see Transaction Types below)
Subtype	subtype	Transaction Subtypes(ENUM)	No	-	Transaction subtype (see Transaction Subtypes below)
Event Time	event_time	string	Yes	-	ISO8601 datetime (YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SSZ)
Amount	amount	string	Yes	-	Transaction value as decimal string (e.g., "1234.56")
Amount Currency	amount_currency	string enum value	Yes	-	Currency enum for `amount` (e.g., "USD" - see currency endpoints)
Sender	sender	TransactionSender	No	-	Transaction sender details (see TransactionSender model)
Receiver	receiver	TransactionReceiver	No	-	Transaction receiver details (see TransactionReceiver model)
Balance	balance	string	No	-	Account balance after transaction as decimal string
Blockchain	blockchain	BlockchainDetails	No	-	Blockchain transaction details (see BlockchainDetails model)

CurrencyAmount

Field	Key	Data Type	Required	Max Length	Description
Amount	amount	string	Yes	-	Amount value as decimal string (e.g., "123.456")
Currency ID	currency_id	integer	No*	-	Currency identifier
Currency Type	currency_type	string enum value	No*	-	Type of currency: `FIAT` or `CRYPTO`

*Both currency_id and currency_type must be provided together or both omitted

TransactionSender

Field	Key	Data Type	Required	Max Length	Description
Entity ID	entity_id	string	No*	-	Unique entity identifier (must map to submitted entity)
Name	name	string	No*	-	Entity name (mutually exclusive with entity_id)
Blockchain Addresses	blockchain_addresses	array[string]	No	-	Associated blockchain addresses
Asset Out	asset_out	CurrencyAmount	No	-	Asset going out from sender (see CurrencyAmount model)

*Either entity_id or name can be provided, but not both

TransactionReceiver

Field	Key	Data Type	Required	Max Length	Description
Entity ID	entity_id	string	No*	-	Unique entity identifier (must map to submitted entity)
Name	name	string	No*	-	Entity name (mutually exclusive with entity_id)
Blockchain Addresses	blockchain_addresses	array[string]	No	-	Associated blockchain addresses
Asset In	asset_in	CurrencyAmount	No	-	Asset coming in to receiver (see CurrencyAmount model)

*Either entity_id or name can be provided, but not both

BlockchainDetails

Field	Key	Data Type	Required	Max Length	Description
Transaction Hash	transaction_hash	string	No	-	Transaction hash on the blockchain
Chain ID	chain_id	integer	No	-	Blockchain network identifier (see chain endpoints)

Transaction Types

String Enum Value	Description
`DEPOSIT`	All funding operations
`WITHDRAWAL`	All cash-out operations
`PAYMENT`	All payment operations
`TRANSFER`	All transfer operations
`TRADE`	All trading operations
`FEE`	All fee operations
`CREDIT`	All credit operations
`INTEREST`	All interest/reward operations
`LOAN`	All loan operations
`REMITTANCE`	All remittance operations
`INTERNAL`	All internal operations
`CHARGEBACK`	All chargeback operations
`OTHER`	All other/unspecified operations
`TRANSACTION`	Generic transaction type

Transaction Subtypes

String Enum Value	Description
`TRADE`	All trading operations
`MARGIN`	Margin trading operations
`PTL-SALE`	Private token launch sales
`EARN_ALLOCATION`	Earning program allocations
`EARN_REWARD`	Earning program rewards
`STAKING`	All staking operations
`REWARD`	Generic rewards and dividends
`ROLLOVER`	Investment rollovers
`DEPOSIT_BANK`	Traditional bank deposits
`DEPOSIT_CRYPTO`	All cryptocurrency deposits
`DEPOSIT_FIAT`	Fiat currency deposits
`DEPOSIT_PROCESSOR`	Payment processor deposits
`ACCOUNT_DEPOSIT`	Account funding operations
`VAULT_DEPOSIT`	Vault/savings deposits
`WITHDRAWAL_BANK`	Traditional bank withdrawals
`WITHDRAWAL_CRYPTO`	All cryptocurrency withdrawals
`WITHDRAWAL_FIAT`	Fiat currency withdrawals
`WITHDRAWAL_PROCESSOR`	Payment processor withdrawals
`CASH_WITHDRAWAL`	ATM/cash withdrawals
`VAULT_WITHDRAWAL`	Vault/savings withdrawals
`E_TRANSFER_SENT`	Electronic transfer sent
`E_TRANSFER_RECEIVED`	Electronic transfer received
`INTERNAL_TRANSFER`	Internal account transfers
`BALANCE_TRANSFER`	Balance transfers between accounts
`P2P_TRANSFER`	Person-to-person transfers
`WIRE_TRANSFER`	Wire transfers
`ACH_TRANSFER`	ACH batch-based transfers
`RTP_TRANSFER`	Real-Time Payments transfers
`CHECK_TRANSFER`	Physical check transfers
`CARD_PURCHASE`	Card-based purchases
`BILL_PAYMENT`	Bill payment transactions
`LOAN_REPAYMENT`	Loan repayment transactions
`CRYPTO_PAYMENT`	Cryptocurrency payment transactions
`CARD_SETTLEMENT`	Card settlement operations
`SERVICE_FEE`	Service fees
`SUBSCRIPTION_FEE`	Subscription fees
`CASHBACK`	Cashback rewards
`CREDIT_TRANSACTION`	Credit transactions
`PROMOTIONAL_CREDIT`	Promotional credits
`INTEREST_EARNED`	Interest earned
`INTEREST_CHARGED`	Interest charged
`TRAVEL_EXPENSE`	Travel-related expenses
`SETTLED`	Settlement operations
`LOAD_PREPAID_CARD`	Prepaid Card Load