Participants

The Participants domain covers everything related to the individuals and entities your platform onboards onto zerohash. A participant is any end user or business you've registered with zerohash so they can hold balances and transact — and these endpoints are how you create, read, and manage those records programmatically.

For engineers, this domain is the backbone of most integrations. Before a participant can trade, settle, or move funds, they need to exist in zerohash, pass KYC, and be eligible for the jurisdiction they're in. These endpoints let you drive that lifecycle from your own systems — onboarding new participants, checking their status, reading their profile and limits, and (where enabled) retrieving their identity data and documents.

There are two ways to onboard participants:

• API integration — Onboard participants directly through these endpoints for a fully integrated solution, using your own frontends. You collect and submit the customer's data, giving you complete control over the onboarding experience.
• zerohash KYC SDK — Alternatively, use the zerohash KYC SDK. With this flow, zerohash performs KYC on the customer's data and provides status updates through the onboarding status notification system or via polling the GET /participants REST API.

Refer to the flow diagram below to see how a platform integrates participant onboarding using these methods.

Getting started

1. Onboard or locate a participant — create a participant (or look one up with the basic management endpoints).
2. Confirm eligibility — use the onboarding & eligibility endpoints to validate the participant's country/jurisdiction.
3. Check KYC status — confirm the participant has passed KYC before enabling product flows.
4. Read profile, and (if enabled) KYC/PII data as your application requires.

Endpoint Groups

Query Participants

Basic participant management.

Read-only lookups for the core participant records zerohash holds — resolve a participant by participant_code or email, list the participants under your platform, and read their profile details. This is typically the first thing you'll integrate, and the foundation for keeping your systems in sync with zerohash.

Participant Jurisdictions

Query countires, sub-divisions and confirm eligibility.

Reference and eligibility endpoints used before and during onboarding — list the supported countries and jurisdictions, and evaluate whether a prospective participant can be onboarded for a given location and product. Use these to drive form validation, gate onboarding flows, and fail fast on ineligible submissions.

Participant Details​

KYC, PII & documents.

Endpoints for reading the sensitive identity data zerohash holds for a participant — KYC status, sanctions screening, full PII records, and uploaded verification documents. Because these return PII, they require enablement by the zerohash support team and are subject to a security review prior to enablement; access is granted on a least-privilege basis.

Participant Onboarding + Account opening

Use the generic onboarding and account-opening flows below as a reference for architecting your integration.

Individual Onboarding SDK + Account Opening

1. Request an onboarding token from the POST /participant/onboarding_token endpoint.
   1. Load the KYCaaS SDK experience using the onboarding token.
   2. Listen for webhook events for the participants Onboarding Status notifications.
2. When a participant has been approved in the zerohash system, you will receive a webhook notificaiton for participant status updates.
3. Once the participant has been approved, open the customer account using the POST /accounts endpoint.
   1. Listen to customer account status updates to consume notifications in real-time.
   2. For more information on customer accounts at zerohash, check out our documentation here.

Individual Onboarding API + Account Opening

• Send the customers PII data to the POST /participants/customers/new endpoint, for participant_code assignment by zerohash.

  1. Add the supporting documentation for the participant if applicable using the POST /participants/documents endpoint.
  2. Listen for webhook events for the participants participant status updates.

• When a participant has been approved in the zerohash system, you will receive a webhook notificaiton for participant status updates.

• Once the participant has been approved, open the customer account using the POST /accounts endpoint.

  • Listen to customer account status updates to consume notifications in real-time.
  • For more information on customer accounts at zerohash, check out our documentation here.

Entity Onboarding API + Account Opening

• Send the customers PII data to the POST /participants/entity/new endpoint, for participant_code assignment by zerohash.

  1. Add the supporting documentation for the participant if applicable using the POST /entity/documents endpoint.
  2. Listen for webhook events for the participants participant status updates.

• When a participant has been approved in the zerohash system, you will receive a webhook notificaiton for participant status updates.

• Once the participant has been approved, open the customer account using the POST /accounts endpoint.

  • Listen to customer account status updates to consume notifications in real-time.
  • For more information on customer accounts at zerohash, check out our documentation here.