Getting Started

Create a Platform

All API, webhook, websocket, and SDK interactions stem from what we call a "Platform". A Platform represents the master account for your business and is your direct link to creating API keys and interacting with our stack.

We support both a Cert (or "test") and a Prod environment. The Cert environment allows developers to simulate transactions using fake funds, accounts, participants, etc. By contrast, the Prod environment is meant for real-life transactions and is subject to various rules and regulations under which Zero Hash operates.

Cert Platform setup instructions

1. Upon request, and after you've established contact with our sales or solutions engineering team, Zero Hash will create a Platform for you. They will add individuals from your business to the Platform. These are called users .
2. Attached users will be sent an email for verification. Click "Confirm my account" within the email body.
3. You'll be prompted to create a username and password + register your 2FA device.
4. You are now logged into the Cert Client Portal.
5. Generate API Keys
6. Whitelist IP Addresses

For reference, the Cert URL for the Client Portal is portal.cert.zerohash.com.

The Cert URL for the API is api.cert.zerohash.com.

Prod Platform setup instructions

1. In contrast to Cert, you will need to initiate the Platform creation process yourself. Go to the Zero Hash portal .
2. Click "Sign Up" - it will prompt you to create a username and password.
3. You'll be sent an email to verify your user account. Click "Confirm my account" on the email body.
4. You'll be prompted to register your 2FA device.
5. You are now logged into the Prod Client Portal.
6. Next, fill out your Platform's business information in the Application. Upon a successful submission, we'll be notified and begin reviewing the information.
7. When the review is complete, we'll approve the Platform account. You will receive an automated email confirming the approval.
8. Before generating API Keys and whitelisting IP addresses, we require your flow of funds to be reviewed and approved by our Compliance and Sales Engineering teams.
9. Generate API Keys
10. Whitelist IP Addresses

For reference, the Prod URL for the Client Portal is portal.zerohash.com

The Prod URL for the API is api.zerohash.com.

API Reference

Familiarize yourself with our API documentation to understand the available endpoints, request parameters, and response formats.

Get Support

If you encounter any issues or have questions about using the Zero Hash API, our support team is here to help. Feel free to reach out to us for assistance navigating the your integration.