ZEzerohash
Query Participants

Get participant status reason details

Changed on

Returns detailed information about a participant's current status, including lock, disable, close, or divest reason codes along with compliance and KYC reasons when applicable. Availability is gated per platform; contact zerohash to enable for your platform.

get/participant/{participant_code}/status_reason

Request

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

Path parameters

participant_codestring required
Example:ABCDEF

Unique participant identifier. Always 6 uppercase alphanumeric characters.

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

Successfully retrieved participant status reason details. including the current status and the reason codes that apply for locked, disabled, closed, or divested participants.

Example response

{
  "message": {
    "participant_code": "CUST01",
    "status": "locked",
    "lock_reason": "compliance_issue",
    "disable_reason": "user_request",
    "close_reason": "compliance_issue",
    "divest_reason": "user_request",
    "compliance_reasons": [
      "fraud",
      "sanctions_confirmed_match"
    ],
    "notes": "Participant flagged for suspicious activity",
    "case_number": "CASE-2024-001",
    "kyc_reasons": [
      "identity_verification_failed"
    ]
  }
}

Changes