These endpoints let you onboard and manage individual customers (natural persons) on zerohash. Onboarding submits a customer's identifying information — and, where required, their identity documents — so zerohash can run KYC and register them to hold balances and transact.
A typical flow looks like this:
- Create the customer with their personal details.
- Upload identity documents if the customer is based outside the US.
- Update the customer later if any details change.
- Lock the customer if you need to restrict their account.
Once created, the customer enters KYC. You should confirm their KYC status before enabling any product flows for them.
What you need to collect
The information required to onboard an individual depends on where they are based. Collecting the right details up front helps avoid failed submissions and KYC delays.
US Citizen
- No document uploads are required. A US customer can be onboarded from their submitted details alone.
- A
tax_idis required (e.g. SSN or ITIN). Onboarding cannot be completed for a US-based customer without it.
Non-US Citizen
- Document uploads are required. Non-US customers must provide identity documentation (proof of ID) as part of onboarding.
zerohash EU platforms
- Document uploads are required. You must provide:
- Proof of ID (e.g. passport or national ID)
- Proof of address
In short:
- US customers → provide a
tax_id, no documents needed.- Non-US customers → identity documents are required.
- EU customers → identity documents and proof of address are required.
Endpoints
- Create a customer — Onboards a new individual customer by submitting their personal details and begins KYC.
- Upload participant documents — Uploads a customer's identity documents (proof of ID and proof of address). Required for non-US customers.
- Update a customer — Updates the details of an existing customer.
- Lock a customer — Locks a customer's account to restrict activity.