How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zero Hash Deposits API

Create deposit addressed and monitor deposits to accounts

Zero Hash Deposits API is one of 31 APIs that Zero Hash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deposits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 13 operations across 9 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.7.0.

Requests are made against a single base URL, https://api.cert.zerohash.com.

13 operations 9 paths 31 schemas 6 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.7.0
Base URL
https://api.zerohash.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Zero Hash Deposits API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-SCX-API-KEY (apiKey). An API key is passed in the header as X-SCX-PASSPHRASE (apiPassphrase). By default, every request must be authenticated.

  • apiKey — Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.
  • apiPassphrase — The passphrase associated with your API key, set when the key was created.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 6 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Deposits 13

Create deposit addressed and monitor deposits to accounts

GET
/deposits/crypto
List crypto deposits
getDepositsCrypto 13 params → 200400403404500503
GET
/deposits/crypto/{deposit_id}
Get crypto deposit by ID
getDepositsCryptoByDepositId 3 params → 200400403404500503
POST
/deposits/digital_asset_addresses
Create deposit address
postDepositsDigitalAssetAddresses 2 params body → 200400403404500503
GET
/deposits/digital_asset_addresses
List deposit addresses
getDepositsDigitalAssetAddresses 6 params → 200400403404500503
PATCH
/deposits/digital_asset_addresses
Update address owner
patchDepositsDigitalAssetAddresses 2 params body → 200400403404500503
POST
/deposits/bolt11
Create a BOLT11 invoice for deposit
postDepositsBolt11 2 params body → 200400403404500503
POST
/deposits/bolt11/test_payment
Create a test payment for a BOLT11 deposit invoice
postDepositsBolt11TestPayment 2 params body → 200400403404500503
POST
/deposits/fund
Fund account
postDepositsFund 2 params body → 201400403404500503
GET
/deposits
List deposits
getDeposits 13 params → 200400403404500503
GET
/deposits/fiat_accounts
List fiat accounts
getDepositsFiatAccounts 2 params → 200400403404500503
POST
/deposits/uma
Create UMA address
postDepositsUma 2 params body → 201400403404500503
GET
/deposits/uma
List UMA addresses
getDepositsUma 5 params → 200400403404500503
PATCH
/deposits/uma
Update UMA address
patchDepositsUma 2 params body → 200400403404500503

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are FiatAccountEntity (16 properties), CryptoDepositEntity (15 properties), DepositResponseEntity (14 properties), PostDepositsFundEntity (7 properties). Each schema is shown below with its type and property counts.

PostDepositsFundResponse
object
1 property
GetDigitalAddressesResponse
object
1 property
CryptoDepositsPaginationEntity
object
2 properties
DigitalAddressesEntity
object
6 properties
PostUMAAddressBody
object
2 properties 2 required
PostBOLT11Response
object
2 properties 2 required
PostDepositsFundBody
object
4 properties 3 required
PostBOLT11TestPaymentBody
object
1 property 1 required
FiatAccountEntity
object
16 properties 6 required
GetDepositsResponse
object
5 properties
GetUMAAddressesResponse
object
2 properties
Code500
object
An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.
1 property 1 required
StateTransitionEntity
object
3 properties
GetFiatAccountsResponse
object
1 property
Asset
string
The list of assets available in the certification environment
Code404
object
The requested resource does not exist or is not visible to the caller.
1 property 1 required
Code503
object
A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a zh-allow-retry: true header.
1 property 1 required
GetCryptoDepositsResponse
object
2 properties
PatchUMAAddressBody
object
3 properties 3 required
UMAAddressEntity
object
6 properties
PatchDigitalAssetAddressesBody
object
3 properties 3 required
PatchDigitalAssetAddressesResponse
object
1 property
Code403
object
Authentication or authorization failed. error is always true; message explains which check failed (missing API key, bad signature, insufficient permission, etc…
2 properties 2 required
PostBOLT11Body
object
6 properties 2 required
DepositResponseEntity
object
14 properties
Code400
object
Request was rejected by validation or a downstream service. errors is an array of human-readable messages; each entry describes a single validation failure or…
1 property 1 required
PostDepositsFundEntity
object
7 properties
CryptoDepositEntity
object
15 properties
PostDigitalAssetAddressesBody
object
3 properties 2 required
GetCryptoDepositByIdResponse
object
1 property
PostDigitalAssetAddressesResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zero-hash-deposits-api-openapi.yml Raw ↑

Other APIs Zero Hash publishes across the network.

zerohash Private WebSocket API
Zero Hash Accounts API
Zero Hash Assets API
Zero Hash Awards API
Zero Hash CLOB API
Zero Hash Convert and Withdraw API
Zero Hash Customer Accounts (MTA) API
Zero Hash Entity Participants API
Zero Hash Fund API
Zero Hash Index API
Zero Hash Individual Participants API
Zero Hash Liquidity API
Where this information came from

This is an independent, third-party profile of Zero Hash Deposits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.