Customer Accounts (MTA)

Get customer account status reason

Changed on

This endpoint returns detailed information about customer account status, including lock reason codes. This endpoint is disabled by default and enabled per platform using feature flags.

get/account/{zrn}/status_reason

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/account/{zrn}/status_reason
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

zrnstring required

The customer account identifier to get status reason details for

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.

Response

Customer account status reason details retrieved successfully

Example response

{
  "message": {
    "zrn": "zrn:zh:us:accounts:customer:c761fc96-5c44-40d4-8eb2-3fcd5d06754b",
    "participant_code": "CUST01",
    "platform_code": "PLAT01",
    "account_label": "account-label",
    "type": "individual",
    "tier": "gold",
    "status": "locked",
    "author_type": "admin",
    "reason": "compliance_issue",
    "compliance_reasons": [
      "fraud",
      "sanctions_confirmed_match"
    ],
    "notes": "Account flagged for suspicious activity",
    "case_number": "CASE-2024-001",
    "tenants": [
      "PAR002"
    ],
    "financial_advisors": [
      "PAR003"
    ]
  }
}

Changes