---
updatedAt: 2026-08-09T16:52:59.000Z
agentTools:
  projectIndex: https://docs.zerohash.com/llms.txt
---

# Get participant status reason details

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.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "zerohash API",
    "description": "\n### Authentication\n\nzerohash Uses HMAC SHA-256 verification to ensure the authenticity of API requests, follow instructions by link [https://docs.zerohash.com/reference/api-authentication](https://docs.zerohash.com/reference/api-authentication)\n\n<a href=\"/zh-swagger.json\">Download zerohash OpenAPI Schema as JSON</a>\n",
    "version": "1.7.0"
  },
  "servers": [
    {
      "url": "https://api.cert.zerohash.com",
      "description": "Certification API server"
    }
  ],
  "x-readme": {
    "proxy-enabled": false
  },
  "tags": [
    {
      "name": "Query Participants",
      "description": "Generic Participant management endpoints"
    }
  ],
  "paths": {
    "/participant/{participant_code}/status_reason": {
      "get": {
        "tags": [
          "Query Participants"
        ],
        "summary": "Get participant status reason details",
        "description": "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.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Signature"
          },
          {
            "$ref": "#/components/parameters/Timestamp"
          },
          {
            "$ref": "#/components/parameters/ParticipantCodePath"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved participant status reason details. including the current status and the reason codes that apply for locked, disabled, closed, or divested participants.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetParticipantStatusReasonResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code400"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code403"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code404"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code500"
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code503"
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "apiKey": [],
      "apiPassphrase": []
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "description": "Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.",
        "in": "header",
        "name": "X-SCX-API-KEY"
      },
      "apiPassphrase": {
        "type": "apiKey",
        "description": "The passphrase associated with your API key, set when the key was created.",
        "in": "header",
        "name": "X-SCX-PASSPHRASE"
      }
    },
    "parameters": {
      "Signature": {
        "name": "X-SCX-SIGNED",
        "in": "header",
        "description": "HMAC-SHA256 signature of the request, base64-encoded. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for the exact signing formula.",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "Timestamp": {
        "name": "X-SCX-TIMESTAMP",
        "in": "header",
        "description": "Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1678901234"
        }
      },
      "ParticipantCodePath": {
        "name": "participant_code",
        "in": "path",
        "description": "Unique participant identifier. Always 6 uppercase alphanumeric characters.",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "^[A-Z0-9]{6}$",
          "example": "ABCDEF"
        }
      }
    },
    "schemas": {
      "Code400": {
        "type": "object",
        "description": "Request was rejected by validation or a downstream service. `errors` is an array of human-readable messages; each entry describes a single validation failure or business-rule violation.",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "body/amount must be >= 0",
              "body/asset is required"
            ]
          }
        }
      },
      "Code403": {
        "type": "object",
        "description": "Authentication or authorization failed. `error` is always `true`; `message` explains which check failed (missing API key, bad signature, insufficient permission, etc.).",
        "required": [
          "error",
          "message"
        ],
        "properties": {
          "error": {
            "type": "boolean",
            "example": true
          },
          "message": {
            "type": "string",
            "example": "This api key does not have write permission to this endpoint"
          }
        }
      },
      "Code404": {
        "type": "object",
        "description": "The requested resource does not exist or is not visible to the caller.",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "example": "Not Found"
          }
        }
      },
      "Code500": {
        "type": "object",
        "description": "An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "example": "Internal Server Error"
          }
        }
      },
      "Code503": {
        "type": "object",
        "description": "A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a `zh-allow-retry: true` header.",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "example": "Service Unavailable"
          }
        }
      },
      "GetParticipantStatusReasonResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "object",
            "properties": {
              "participant_code": {
                "type": "string",
                "description": "Unique participant code",
                "example": "CUST01"
              },
              "status": {
                "type": "string",
                "description": "The current status of the participant",
                "example": "locked"
              },
              "lock_reason": {
                "type": "string",
                "description": "Reason code for locked participants",
                "example": "compliance_issue"
              },
              "disable_reason": {
                "type": "string",
                "description": "Reason code for disabled participants",
                "example": "user_request"
              },
              "close_reason": {
                "type": "string",
                "description": "Reason code for closed participants",
                "example": "compliance_issue"
              },
              "divest_reason": {
                "type": "string",
                "description": "Reason code for divested participants",
                "example": "user_request"
              },
              "compliance_reasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Array of compliance issue reason codes",
                "enum": [
                  "restricted_jurisdiction",
                  "abandoned_escheat",
                  "child_abuse_material",
                  "darknet_market",
                  "gambling",
                  "illicit",
                  "merchant",
                  "mixer",
                  "nft_marketplace",
                  "scam",
                  "terrorist_organization",
                  "thief",
                  "shielded",
                  "victim_of_fraud_or_illicit_activity",
                  "fraud",
                  "cash_spike_incoming",
                  "cash_spike_outgoing",
                  "structured_transactions",
                  "cannabis_name_match",
                  "potential_elder_financial_exploitation",
                  "other_aml_cft_illicit_activity",
                  "sanctions_possible_match",
                  "sanctions_confirmed_match",
                  "politically_exposed_person_foreign",
                  "politically_exposed_person_domestic",
                  "other_cdd_issue",
                  "other_financial_crimes",
                  "referral_from_platform",
                  "impossible_travel_rule",
                  "multiple_incorrect_dob_rule",
                  "blocklisted_pii",
                  "referral_from_platform_imposter_scam",
                  "referral_from_le",
                  "other",
                  "fincen_primary_ml_concern",
                  "sanctions_direct",
                  "sanctions_indirect",
                  "other_high_risk_entity_exposure",
                  "market_abuse_manipulation",
                  "ach_return_unauthorized_transaction",
                  "ach_return_insufficient_funds",
                  "ach_return_other",
                  "gsc_pep",
                  "gsc_adverse_media",
                  "deceased",
                  "discontinued_customer",
                  "edd_required",
                  "kyc_refresh"
                ],
                "example": [
                  "fraud",
                  "sanctions_confirmed_match"
                ]
              },
              "notes": {
                "type": "string",
                "description": "Additional notes about the participant status",
                "example": "Participant flagged for suspicious activity"
              },
              "case_number": {
                "type": "string",
                "description": "Case number associated with the participant status",
                "example": "CASE-2024-001"
              },
              "kyc_reasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Array of KYC-related reason codes",
                "example": [
                  "identity_verification_failed"
                ]
              }
            }
          }
        }
      }
    }
  }
}
```