added

Account Label Added to Deposits Endpoint

Release Date

Wednesday, February 1, 2023

Release Type

Informational – Please see the “Action Required” section for instructions on enabling this feature.

Summary

Zero Hash has now added the ability for platforms to provide an account label when using the following endpoint:

  • POST /deposits/digital_asset_addresses

Prior to this release, platforms were not able to designate a specific account label for a digital asset deposit, and thus could not create different on-chain digital asset addresses for a customer that had multiple accounts on their platform.

Account Labels can be thought of as "sub account groups". Within each account group, you can have many account labels. They are used to separate funds at a more granular level. One individual can have two separated BTC accounts, for example.

Platforms are now able to designate a specific account label when creating multiple digital asset addresses. This functionality is available on a per participant and per asset basis. If Zero Hash receives a new account label within the deposit request, a new on-chain address will be created. Please note that each on-chain address creation event will incur network fees.

Account labels must conform to the following criteria:

  • Account labels are case sensitive and can be a maximum of 40 characters
  • Only numbers, letters, hyphens, and underscores are allowed.
  • Sending the same account label with different cases will result in multiple accounts being created.

Action Required

If you would like to enable this feature, please reach out to [email protected]. This will allow our team to properly configure platform settings to create multiple on-chain addresses per participant code per asset.

Endpoints Impacted

The following endpoint is impacted due to this feature improvement, the change being available in both Cert and Production environments:

  • POST /deposits/digital_asset_addresses

Relevant Documentation