Release Notes

ISO 3166 Migration

Release Details

Release date: Sep 6, 2024

Release Type

Informational

Summary

Zero Hash is migrating to ISO 3166 standards for Country and Subdivision Codes to streamline implementation and avoid any ambiguity around country names. Note that this relates to country of residence, citizenship and optionally id issuing authority.

The following guide should be used as an integration reference.

At this time, this is NOT a breaking change.

  • All current participants are updated to include a jurisdiction_code.
  • For new participants Zero Hash will accept either Country & State OR jurisdiction_code, we will back fill the other fields until further notice.

Action Required

Reach out to your relationship manager to learn more about the integration process.

We advise Platforms to begin working on migrating to the ISO 3166 standards as we will deprecate the legacy fields at a later date. We will provide ample notice prior to deprecating to ensure a seamless migration.

Platforms using the Onboarding SDK:

Platforms using our Onboarding SDK do not have to make any change to Onboard new participants. However, GET /participants will now return jurisdiction_code as well as country and state.

Endpoints impacted

Three additional assets allowed in NY: Cardano, Dogecoin, Shiba Inu

We are pleased to announce that three additional assets are now available for deposits, withdrawals, buys, and sells in New York. Previously these assets were restricted even for platforms that had been approved for NY activity.

Updates in CERT and PROD environments

The following assets/symbols are enabled in CERT and PROD for all permitted NY activity:

  • Cardano (ADA)
  • Dogecoin (DOGE)
  • Shiba Inu (SHIB.ETH)

Note: These changes only apply to the Base Asset and do not apply to any tokens or stablecoins on these networks. Please direct any questions to your Zero Hash support team.

Further Reading

To see the full list of supported Assets, please refer to our new documentation pages:

Platform Communications to New York Persons:

Any platform that wishes to communicate this launch as a Platform to New York persons, you must follow the below template:

We are pleased to announce the addition of Cardano, Dogecoin, and Shiba Inu to our platform.

Customers in the State of New York can now perform deposits, withdrawals, buys, and sells.

[Platform Name] and customers are still restricted from certain activities outlined on this page.

Cryptocurrency transaction and custody services are powered by Zero Hash LLC and Zero Hash Liquidity Services LLC. Zero Hash LLC and Zero Hash Liquidity Services LLC are licensed to engage in Virtual Currency Business Activity by the New York State Department of Financial Services.

Upcoming Migration of MATIC to POL

Release Details

Release Date: Aug 16, 2024

Updated: Aug 30, 2024

  • There will not be a maintenance window for the Ethereum blockchain at this time
  • Target time of the migration (12pm UTC / 8am ET) on September 4th added

Release Type

This migration impacts the MATIC token on both Polygon and Ethereum:

  • Informational – No action required for platforms holding MATIC.POLYGON on the Polygon blockchain. Optional action for platforms holding MATIC.ETH on the Ethereum blockchain

Summary

On September 4th, 2024 at around 12pm UTC (8am ET), the Polygon Foundation will migrate the native Polygon token from MATIC to POL.

  • MATIC.POLYGON on the Polygon blockchain
    • September 4, 2024 around 12pm UTC (8am ET): POL will replace MATIC as the native gas and staking token for the Polygon PoS network.
    • Zero Hash will continue to use the existing symbol MATIC.POLYGON so no change to your integration is required. This symbol in the backend will link to the POL token on Polygon.
    • The name on our public documentation and asset support pages will remain "Polygon (Native)"
    • We will announce plans in the future to change the symbol to represent the POL token.
  • MATIC.ETH on the Ethereum blockchain
    • A new token POL.ETH will be added with only sends and receives available until our Liquidity Providers complete their migrations
    • MATIC.ETH will continue to be available for buy/sell/send/receive
    • At a future date, MATIC.ETH will be fully migrated to POL.ETH
      • On that date, Zero Hash will stop transactions involving MATIC.ETH and open a maintenance window in order to execute the migration to the new token.
    • Both MATIC.ETH (custody and liquidity) and POL.ETH (custody-only) will be available beginning Sept 4

Action Required

No action needed if using MATIC.POLYGON (the native token on Polygon blockchain).

  • The symbol and asset will continue to work uninterrupted.

Optional action if holding MATIC.ETH (the ERC20 token on Ethereum):

  • Zero Hash will add a new token POL.ETH as Custody-only (send and receive only)
  • No downtime will occur on September 4th. A maintenance window will occur at a future date when Zero Hash migrates MATIC.ETH to POL.ETH to enable buys and sells.

Endpoints Impacted

No endpoint are changing as part of this migration.


Relevant documentation

Lightning Network Transaction Limits and Controls

Release Details

Release Date: Aug 13, 2024

Release Type

Informational – Optional action from platforms

Summary

Transaction limits are being implemented on August 21, 2024 for Lightning Network transactions. The limits will vary depending on the direction of the transaction and the Lightning Network standard (BOLT11, LNURL, UMA) used.


BOLT11 / LNURL Transaction Limits

TransactionControl DescriptionControl
WithdrawalsAggregate Transaction Daily Maximum Amount$2,500 daily limit
DepositsInvoice Maximum Amount$1,000 USD per invoice
DepositsInvoice Daily Maximum$1,000 USD per day
DepositsLifetime volume triggering Enhanced Due DiligenceTier 1:
At $10k cumulative deposit volume, require additional EDD information to be sent.

Tier 2:
At $100k deposit volume in rolling 30 days, participant will trigger manual review

UMA Transaction Limits

Specific transaction limits are not implemented, however, every VASP that will send or receive UMA transactions with Zero Hash must go through a Compliance due diligence review and have their UMA server domain allowlisted first. Domains that are not part of the Zero Hash allowlist will have their transactions rejected.

  • Withdrawals: Zero Hash will work with the receiving VASP to coordinate the information required to be sent.
  • Deposits: Zero Hash will determine the information the sending VASP must include with their UMA transactions.

Action Required

While no implementation changes are required, transactions that exceed these amounts or that push the total volume over this amount will return an error.

If you are planning to implement UMA with an external VASP then they will need to go through the above due diligence process. This process can be initiated by contacting your Zero Hash representative.


Endpoints Impacted


Relevant documentation

Updated Response on PATCH Participants

Release Details

Release Date: Aug 2, 2024

Release Type

Informational – Optional action from platforms

Summary

Platforms currently using the KYC as a Service product will see a reduced set of fields returned by the PATCH /participants/customers/ endpoint as seen in the sample response below.

  • CERT Aug 2, 2024
  • PROD Aug 2, 2024

Remaining platforms and all API users will see the fields returned by the PATCH /participants/customers/ endpoint updated to the below sample response on:

  • CERT Aug 12, 2024
  • PROD Sep 2, 2024

Once this change is live for your platform, only the below fields will be returned even if you updated a field not included in the response. The change was successful if you received a 200 response.

Action Required

Action is needed if your platform is reliant on any of the fields that will be removed from the response. Please review your current use of PATCH /participants/customers/ to determine if there is any impact.

Endpoints Impacted

Sample Response:

  • After platform submits a customer information update via PATCH /participants/customers/, Zero Hash responds:
{
    "message": {
        "first_name": "John",
        "last_name": "Smith",
        "country": "United States",
        "state": "IL",
        "email": "[email protected]",
        "platform_code": "PLAT01",
        "participant_code": "CUST01"
    }
}

Onboarding: phone number exception

Release Details

Release Date: July 29th, 2024

Release Type

Informational – Optional action from platforms

Summary

Select Platforms can now onboard a natural person customer by submitting a phone number instead of an email address. This allows Platforms to onboard customers in certain jurisdictions where having an email address is less prevalent. Please note: your Platform must be approved by Zero Hash's legal and compliance team before using this feature.

Action Required

For Platforms that are configured properly, simply pass a phone_number instead of an email on the POST /participants/customers/new endpoint. If a Platform omits a phone_number, the API call will be rejected. A configured platform may still pass an email if they wish as well.

Endpoints Impacted

Example:

  • Platform submits a customer via POST /participants/customers/new:
{
    "first_name": "John",
    "last_name": "Smith",
    "phone_number": "1234567890",
    "address_one": "1 Main St.",
    "address_two": "Suite 1000",
    "kyc":"pass",
    "city": "Chicago",
    "state": "IL",
    "zip": "12345",
    "country": "United States",
    "date_of_birth": "1985-09-02",
    "id_number_type": "ssn",
    "id_number": "123456789",
    "signed_timestamp": 1712008721000,
    "metadata": {
        "cip_kyc": "12345"
    }
}
  • Zero Hash responds:
{
    "message": {
        "first_name": "John",
        "last_name": "Smith",
        "phone_number": "1234567890",
        "address_one": "1 Main St.",
        "address_two": "Suite 1000",
        "country": "United States",
        "state": "IL",
        "city": "Chicago",
        "zip": "12345",
        "date_of_birth": "1985-09-02",
        "id_number_type": "ssn",
        "id_number": "123456789",
        "non_us_other_type": "",
        "id_issuing_authority": "",
        "signed_timestamp": 1712008721000,
        "risk_rating": "",
        "metadata": {},
        "platform_code": "PLAT01",
        "participant_code": "CUST01",
        "tax_id": "123456789",
        "citizenship": "United States",
        "kyc": "unknown",
        "kyc_timestamp": null,
        "onboarded_location": "",
        "sanction_screening": "unknown",
        "sanction_screening_timestamp": null,
        "idv": "unknown",
        "liveness_check": "unknown",
        "phone_number": "",
        "employment_status": "unknown",
        "industry": "unknown",
        "source_of_funds": "unknown",
        "signed_agreements": [
            {
                "region": "us",
                "signed_timestamp": 1712008721,
                "type": "user_agreement"
            }
        ]
    }
}

A customer participant code has been created and is eligible to be used in subsequent API calls.

ACH and RTP: Close linked bank accounts

Release Details

Release Date: July 19, 2024

Release Type

Informational – Optional action from platforms

Summary

Customer bank accounts are linked to Zero Hash for ACH and RTP using Create external accounts. We've introduced the ability to also close external accounts so the bank account can be unlinked from the customer's Zero Hash profile.

Once an account is closed, transaction requests cannot be made using that external account ID. The bank account would need to be relinked if the customer wanted to use that bank account again.

Action Required

If leveraging ACH and/or RTP, platforms may choose to connect to the endpoint to close external accounts: Close external account.

This will unlink the bank account from Zero Hash, but it will not unlink the bank account from Plaid.

External account statuses

The external account will have a status of closed once it's unlinked. A full list of possible external account statuses are available here.

SDK Impact

The external account closed won't be available as funding option for the customers in the SDK.

Endpoints Impacted

Relevant Documentation

https://docs.zerohash.com/docs/link-a-bank-account#close-external-accounts

Convert & Withdraw Support for BOLT 11 Lightning Network Invoices

Release Details

  • Release Date: July 18, 2024

Release Type

Informational – Optional action from platforms

Summary

Fiat can be converted to Bitcoin and withdrawn to a BOLT11 Lightning Network invoice using the Convert_withdraw endpoint.

Note that Lightning Network withdrawals, including convert_withdraw, are NOT allowed for New York participants at this time.

Action Required

Convert_withdraw on the Lightning Network is immediately available to all platforms in the certification (CERT) environment and follows the convention in the convert_withdraw guide.

Lightning Network calls can only be used with the ByQuantity transaction type (ByTotal will return an error).

  • Generate an RFQ Quote ID using POST /convert_withdraw/rfq (API Link)
  • Execute the Quote ID by calling POST /convert_withdraw/execute (API Link)

Endpoints Impacted

There are no changes to existing endpoints as a result of this launch, however a Lightning Network invoice will need to be input instead of an L1 destination address.

The asset symbol used for these transactions is still BTC however the destination address format will determine the network used.

Relevant Documentation

Please see the Convert Withdraw and Lightning Network Testing Guides for additional details:

Enhanced Zero Hash Transfers

Summary

Zero Hash currently supports the ability for customers and platforms to direct the movement of their crypto via internal transfers (always off-chain) and withdrawals. This feature is opt-in and can be enabled by speaking to your Zero Hash representative.

A withdrawal may be sent to an external address or a Zero Hash controlled address. When a withdrawal is made to a destination that is a Zero Hash controlled address, Zero Hash now recognizes this and executes an internal transfer as opposed to an on-chain transfer. As such, there is no on-chain transfer and as such, no network fee assessed. This applies to all assets (full list of assets found here).


Impacted Endpoints

This launch is not a breaking change, however you will need to request to be opted-in first, will apply to the following endpoints:

  • POST /withdrawals/requests
  • POST /convert_withdraw/rfq
  • POST /convert_withdraw/execute
  • GET /withdrawals/requests
  • GET /withdrawals/requests/{id}
  • GET /withdrawals/locked_network_fee
  • POST /withdrawals/execute

How will I know if my withdrawal was transferred internally?
If an internal transfer for a withdrawal has occurred, the tx_hash in the GET /withdrawals/requests and GET /withdrawals/requests/{id} will have the following format:

  • withdrawal side -> internalp2p_debit{withdrawal_uuid}
  • deposit side -> internalp2p_credit{withdrawal_uuid}

For GET /withdrawals/locked_network_fee, an internal transfer will return 0 for the network fee.

These responses mean that an internal omnibus transfer has occurred because the recipient address is a Zero Hash controlled address. There is no on-chain transfer and as such, no network fee assessed.

If a withdrawal is on-chain, a network fee shall be assessed and the on-chain tx hash shall be returned that can be viewed on a third-party blockchain explorer.


Further Reading

Three additional assets allowed in NY: Aptos, Stellar, SUI

We are pleased to announce that three additional assets are now available for deposits, withdrawals, buys, and sells in New York. Previously these assets were restricted even for platforms that had been approved for NY activity.


Updates in CERT and PROD environments

The following assets/symbols are enabled in CERT and PROD for all permitted NY activity:

  • Aptos (APT)
  • Stellar (XLM)
  • SUI (SUI)

Note: These changes only apply to the Base Asset and do not apply to any tokens or stablecoins on these networks. Please direct any questions to your Zero Hash support team.


Further Reading

To see the full list of supported Assets, please refer to our new documentation pages:



Platform Communications to New York Persons:

Any platform that wishes to communicate this launch as a Platform to New York persons, you must follow the below template:

We are pleased to announce the addition of Aptos, Stellar, and SUI to our platform.

Customers in the State of New York can now perform deposits, withdrawals, buys, and sells.

[Platform Name] and customers are still restricted from certain activities outlined on this page.

Cryptocurrency transaction and custody services are powered by Zero Hash LLC and Zero Hash Liquidity Services LLC. Zero Hash LLC and Zero Hash Liquidity Services LLC are licensed to engage in Virtual Currency Business Activity by the New York State Department of Financial Services.