Note
The AML integration is a premium feature that requires an additional purchase. Reach out to your Customer Success Manager if you do not have an agreement with an AML provider or you need help enabling the feature.
Overview
You can automatically associate users with incoming and outgoing transactions by assigning a Customer Reference ID with the Fireblocks API. Providing this information to your Anti-Money Laundering (AML) provider lets you view the potential risk of transacting with each user. It also helps with compliance and AML investigations by making connections between transactions and identifying illegal patterns and behavior.
A transaction that touches a deposit address or vault account with a Customer Reference ID is automatically associated with that Customer Reference ID. Additionally, setting a Customer Reference ID of a SegWit address updates the Legacy address and vice versa.
Customer Reference IDs can be helpful when differentiating transaction screenings from multiple workspaces, vault accounts, asset wallets, and transactions.
Incoming transactions
For incoming transactions, you can set the Customer Reference ID for the following:
- A specific deposit address, using the Assign AML customer reference ID endpoint
- A specific destination vault account, using the Set an AML/KYT customer reference ID for a vault account endpoint
Note
For Ripple (XRP), Stellar (XLM), and other tag-based incoming transactions, you can also attach a Customer Reference ID to the transaction’s tag.
Outgoing transactions
For outgoing transactions, you can set the Customer Reference ID for the following:
- When you use the Create a new transaction endpoint
- A specific internal wallet address, using the Set an AML/KYT customer reference ID for an internal wallet endpoint
- A specific external wallet address, using the Set an AML customer reference ID for an external wallet endpoint
- A specific source vault account, using the Set an AML/KYT customer reference ID for a vault account endpoint
Supported characters
Customer Reference IDs can be up to 200 characters. You can use the following characters:
- a-z
- A-Z
- 0-9
- Dash (-)
- Underscore (_)
- Colon (:)
What happens when Customer Reference IDs overlap?
A fixed order determines the Customer Reference ID when Customer Reference IDs overlap.
- Incoming transactions: Deposit addresses override destination vault accounts.
- Outgoing transactions: Transactions override destination wallets, and destination wallets override source vault accounts.