API Specificationv1.0.0
EtherVault developer kit
Integrate verification processes directly into your native infrastructure. Query issued certificates, authorize administrative agents, and issue cryptographically anchored metadata.
Core Endpoints
Security & Headers
Public Endpoint
POST/api/document/verify
Verify Document
Public Access (Rate limited)
Verifies the cryptographic authenticity of an issued credential using either its secure SHA-256 hash value or its alphanumeric Verification ID.
Payload / Parameters
verifyIdStringOptional
Alphanumeric unique identification ID generated on issuance (e.g. DOC-A1B2C3). Required if 'hash' is not provided.
hashStringOptional
Cryptographic SHA-256 hash of the raw document file. Required if 'verifyId' is not provided.
Response Codes
200 SuccessDocument successfully located on-chain. Returns document structure, transaction hash, and revocation state.
400 Bad RequestMissing parameters or both 'hash' and 'verifyId' provided.
404 Not FoundDocument with specified hash or ID does not exist in the vault.
curl -X POST http://localhost:3001/api/document/verify \
-H "Content-Type: application/json" \
-d '{"verifyId": "DOC-"}'