Overview

You may want to or be required to add end-client identification information to vault accounts and wallets. Depending on the purpose, you can use different endpoints and parameters to do this.

Internal or auditing identification purposes

Vault accounts

When an end client owns (or will own) all the wallets and addresses inside a vault account, call one of the following endpoints:

• Create a new vault account (for new vault accounts)
• Rename a vault account (for existing vault accounts)

Then, use the name parameter to enter their identification information (e.g., "Customer_12345_Vault"). This propagates the information to every transaction that uses that vault account.

🚧

Please make sure to not pass any PII data!

Wallets

When an end client owns (or will own) only one or only a few wallets inside a vault account containing many other wallets, call one of the following endpoints:

• Create an internal wallet (for new internal wallets)
• Create an external wallet (for new external wallets)

Then, use the name parameter to enter their identification information (e.g., "Customer_12345_Wallet"). This propagates the information to every transaction that uses that wallet.

📘

Note

Wallets cannot be renamed, so you must create new wallets for existing end client wallets.

Deposit Addresses

When an end client owns (or will own) only one or only a few deposit addresses inside a wallet containing many other addresses, call one of the following endpoints:

• Create a new asset deposit address (for new deposit addresses)
• Update address description (for existing deposit addresses)

Then, use the description parameter to enter their identification information (e.g., "Customer_12345_Address"). This propagates the information to every transaction that uses that deposit address.

AML/CFT identification purposes

❗️

Warning

The customerRefId parameter should be used only for this purpose, as AML providers use it to associate the owner of funds with transactions.

Vault accounts

When an end client owns (or will own) all the wallets and addresses inside a vault account, call one of the following endpoints:

• Create a new vault account (for new vault accounts)
• Set an AML/KYT customer reference ID for a vault account (for existing vault accounts)

Then, use the customerRefId parameter to enter their identification information (e.g., "Customer_12345_Vault"). This propagates the vault account's name, the wallet address, the asset name, and the end client’s information to every transaction that uses that vault account.

Wallets

When an end client owns (or will own) only one or only a few wallets inside a vault account containing many other wallets, call one of the following endpoints:

• Create an internal wallet (for new internal wallets)
• Create an external wallet (for new external wallets)
• Set an AML/KYT customer reference ID for an internal wallet (for existing internal wallets)
• Set an AML/KYT customer reference ID for an external wallet (for existing external wallets)

Then, use the customerRefId parameter to enter their identification information (e.g., "Customer_12345_Wallet"). This propagates the name of the vault account containing the wallet, the wallet address, the asset name, and the end client’s information to every transaction that uses that wallet.

Deposit Addresses

When an end client owns (or will own) only one or only a few deposit addresses inside a wallet containing many other addresses, call one of the following endpoints:

• Create a new asset deposit address (for new deposit addresses)
• Assign AML customer reference ID (for existing deposit addresses)

Then, use the customerRefId parameter to enter their identification information (e.g., "Customer_12345_Address"). This propagates the name of the vault account containing the wallet, the wallet address, the description of the deposit address, the asset name, and the end client's information to every transaction that uses that deposit address.