ZEzerohash
Query Participants

Get participant basic info

Changed on

This endpoint returns Participant basic info.

get/participant/{participant_code}/basic_info

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/participant/{participant_code}/basic_info
  • 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 basic information. Including participant code, name, type, and status.

Example response

{
  "message": {
    "participant_code": "ABCDEF",
    "status": "approved",
    "action": "update",
    "participant_type": "INDIVIDUAL",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "submission_method": "API",
    "signed_timestamp": 1603378501286,
    "created_at": 1603378501286,
    "last_updated": 1680643465352,
    "jurisdiction_code": "US-IL"
  }
}

Changes

  • 47cf70ae701cRevision changes
    • warning

      added the new BUSINESS enum value to the / response property for the response status

    • warning

      added the new INDIVIDUAL enum value to the / response property for the response status