Account Management

We power CLOB trading account activation via REST API, allowing platforms to stand up funded accounts for approved participants and manage those accounts over their lifetime.

Flexible Funding Models

You have the ability to activate accounts under either funding model, selected at creation via the prefunded flag:

  • Pre-Funded (prefunded: true): Customer USD balances are held at zerohash, and ledgered directly to the customer.
  • Non Pre-Funded (prefunded: false): Platform is utilizing a float account for buying power, while participants USD balances remain on the platform's ledgers.
    • The platform performs credit checks buy orders before submitting to the order book.
      • Participants buy order placements should be rejected if balance cannot cover the order notional + commissions on your ledger.
    • Cumulative buying power for your customers will be held in your platform float account.
    • Open buy limit orders will be collateralized from the platform's float, and debited accordingly upon order execution.

Sequential Dependency

The endpoints work in tandem across the account lifecycle:

  1. Create Participant: Platforms register the end user as a participant on the zerohash system.
    1. Individual participant creation via POST /participants/customers/new.
    2. Entity participant creation via POST /participants/entity/new .
  2. Confirm Approval: Verify the participant's status is approved.
    1. Query the participants status via GET /participant/{participant_code}/basic_info.
    2. Subscribe to participant status updates, through the zerohash webhook notifications service.
  3. Activate Account: Submit the approved participant_code and chosen funding model.
    1. CLOB account opening should be carried out via the POST /accounts​endpoint.
    2. Platforms can elect a custom account_label to help manage participants account balances more granularly, maintaining a dedicated balance per account_label.
      1. The response will return a zrn assigned by zerohash, that will be used in subsequent calls for customer account management.
  4. Retrieve & Update: Platforms can use the following endpoints to assist in account management.
    1. Platforms can retrieve account details via GET /clob/accounts endpoint, passing the desired query parameters.
    2. Platforms can update account attributes using the PATCH /clob/accounts.

Configuration Review

Please review the different permutations of the API request body. It is vital to ensure your platform uses the intended parameters (e.g., individual vs. entity participant creation, prefunded: true vs prefunded: false, and the correct participant_code / account_group / account_label pairing) corresponding to your specific business logic to avoid funding and credit-check discrepancies on the CLOB.