These endpoints cover the day-to-day reading of participant records — the core data zerohash holds about the participants you've onboarded. They're read-only (GET) lookups you'll use to keep your own systems in sync with zerohash and to drive participant-aware logic in your application.
From an integration standpoint, this is usually the foundation an engineer builds first: you need to resolve a participant by their code or email, list the participants under your platform, read their core profile details, and understand the limits applied to them. Common uses include:
- Sync and reconciliation — pull participant records (individually or in bulk via
List participants) to reconcile against your own database, backfill new integrations, or audit which participants exist under your platform. - Participant lookups — resolve a single participant by email with
Get participant, or read core profile details withGet participant basic info, to power internal dashboards, support tooling, and customer-facing account screens. - Limit-aware logic — read a participant's configured limits with
List participant limitsto validate or display transaction/withdrawal thresholds before an action is attempted, so you can surface clear messaging instead of hitting a downstream rejection. - Onboarding status checks — confirm a participant is present and active before enabling product flows that depend on them.
Unlike the KYC/PII endpoints, these basic management lookups return operational participant data and are part of the standard integration surface.
Endpoints
- Get participant — Retrieves a single participant record by email address.
- List participants — Returns a paginated list of the participants onboarded under your platform.
- Get participant basic info — Returns core identifying details for a participant (name, contact, participant code, status).
- List participant limits — Returns the limits configured for a participant (e.g. transaction or withdrawal thresholds).