--- updatedAt: 2026-08-09T16:52:59.000Z agentTools: projectIndex: https://docs.zerohash.com/llms.txt --- # Get participant document metadata Returns a list of KYC document metadata for a participant. Does not include document contents or signed URLs. # 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\nDownload zerohash OpenAPI Schema as JSON\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}/full_info/document_metadata": { "get": { "tags": [ "Query Participants" ], "summary": "Get participant document metadata", "description": "Returns a list of KYC document metadata for a participant. Does not include document contents or signed URLs.", "parameters": [ { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/Timestamp" }, { "$ref": "#/components/parameters/ParticipantCodePath" } ], "responses": { "200": { "description": "Successfully retrieved document metadata list. Returns an empty array if no documents exist for the participant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentMetadataResponse" } } } }, "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" } } }, "DocumentType": { "type": "string", "enum": [ "articles_of_incorporation", "articles_of_organization", "business_license", "business_name_filing_document", "by_laws", "certificate_of_good_standing", "certificate_of_incorporation", "certificate_of_organization", "operating_agreement", "partnership_agreement", "proof_of_address", "proof_of_non_profit_status", "legacy_document", "miscellaneous", "ssn", "us_drivers_license", "us_passport", "us_passport_card", "us_permanent_resident_card", "us_border_crossing_card", "us_alien_card", "us_id_card", "non_us_passport", "non_us_other", "investor_category_agreement", "us_temporary_resident_card", "us_visa", "proof_of_income", "eu_passport", "eu_id_card", "eu_drivers_license", "eu_address_verification", "form_w9", "form_w8_ben", "form_w8_ben_e", "form_w8_imy", "form_w8_eci", "form_w8_exp", "form_w8_ce", "source_of_funds_for_purchase", "proof_of_employment_status", "proof_of_industry", "excerpt_of_the_chamber_of_commerce", "proof_of_residence", "articles_of_associations", "trust_agreement", "certificate_of_good_conduct_of_entrepreneur", "certificate_of_good_conduct_of_nnp", "source_of_funds", "financial_report", "certified_valid_id_of_control_person_and_beneficial_owner", "power_of_authorization", "official_proof_of_public_legal_entity_status", "id_of_submitter", "group_of_companies_chart_including_affiliated_foundation", "lei_certificate", "annual_accounts", "legal_opinion", "supporting_document" ], "description": "Type of KYC document.", "example": "us_passport" }, "DocumentMetadataEntity": { "type": "object", "properties": { "document_id": { "type": "string", "description": "Unique identifier (SHA-256 hash) for the document.", "example": "e39e7b6a908e397dac50e461eb2d284820214ca2cb3c4aa9aeb9dfc1873332a0" }, "file_name": { "type": "string", "description": "Original file name of the uploaded document.", "example": "passport.pdf" }, "participant_code": { "type": "string", "description": "Unique alphanumeric code for the participant (format: 6 alphanumeric characters).", "example": "ABCDEF" }, "document_type": { "$ref": "#/components/schemas/DocumentType" }, "id_front": { "type": "boolean", "description": "Indicates whether this is the front side of an ID document. Only present/applicable when the document is an identity document with front/back sides." }, "created_at": { "type": "number", "format": "int64", "description": "Unix timestamp in milliseconds indicating when the document was uploaded.", "example": 1678901234567 } } }, "GetDocumentMetadataResponse": { "type": "object", "properties": { "message": { "type": "object", "properties": { "participant_code": { "type": "string", "description": "Unique alphanumeric code for the participant (format: 6 alphanumeric characters).", "example": "ABCDEF" }, "documents": { "type": "array", "description": "Array of document metadata objects for the participant. Returns an empty array if no documents exist.", "items": { "$ref": "#/components/schemas/DocumentMetadataEntity" } } } } } } } } } ```