ZEzerohash
Customer Accounts (MTA)

Create customer account

Changed on

Creates a new customer account. The pair (participant_code, account_label) is unique per participant and is used as idempotency check rather than X-Request-Id; submitting the same pair a second time returns an error rather than creating a duplicate.

post/accounts

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/accounts
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

OR
OR
OR
OR
OR
OR

Example request

{
  "participant_code": "PAR001",
  "account_label": "custom-account-label",
  "tier": "pro",
  "type": "individual",
  "financial_advisors": [
    "PAR003"
  ]
}

Response

Creating a customer account is an asynchronous process that does several operations in the background after the response is returned. Customers are advised to listen to the customer_account_status_changed webhook event to be notified when the account is active and ready to use.

Example response

{
  "message": {
    "zrn": "zrn:zh:us:accounts:customer:c761fc96-5c44-40d4-8eb2-3fcd5d06754b",
    "participant_code": "PAR001",
    "platform_code": "PLAT01",
    "account_label": "custom-account-label",
    "account_group": "XYZ456",
    "type": "individual",
    "tier": "pro",
    "status": "open",
    "tenants": [
      "PAR002"
    ],
    "financial_advisors": [
      "PAR003"
    ]
  }
}

Changes

  • 47cf70ae701cRevision changes
    • breaking

      removed subschema #1: Individual Customer Account subschema #2: Business Customer Account subschema #3: Joint Tenant in Common Account subschema #4: Joint Tenant With Right of Survivorship Account subschema #5: Trust Account subschema #6: UTMA Account subschema #7: Customer Account - All Fields from the request body oneOf list

    • info

      added subschema #1: Individual Customer Account subschema #2: Business Customer Account subschema #3: Joint Tenant in Common Account subschema #4: Joint Tenant With Right of Survivorship Account subschema #5: Trust Account subschema #6: UTMA Account subschema #7: Customer Account - All Fields to the request body anyOf list