Skip to Content

API reference

HTTP endpoints for anchoring and receipt retrieval.

Authentication

If ATL_ACCESS_TOKENS is set, all /v1/* endpoints require:

Authorization: Bearer <token>

POST /v1/anchor

Create new log entry and return immediate receipt.

Request:

{ "payload": {}, "metadata": {}, "external_id": "optional-string" }
  • payload — any JSON value to anchor (hashed, not stored)
  • metadata — optional cleartext metadata included in receipt
  • external_id — optional client correlation ID

Response: 201 Created

Returns Receipt-Lite (no super_proof, no anchors). Use upgrade_url to fetch updated receipt later.

GET /v1/anchor/{id}

Fetch current receipt for existing entry.

Parameters:

  • id — entry UUID

Response: 200 OK

Returns current receipt with any anchors available at the time.

GET /health

Health check endpoint (node and sequencer modes only).

Response: 200 OK or 503 Service Unavailable

{ "status": "healthy", "mode": "NODE", "sequencer_connected": true }

Errors

All errors return JSON:

{ "error": "human readable message", "code": "MACHINE_READABLE_CODE", "recoverable": false }

Common codes:

  • AUTH_MISSING, AUTH_INVALID — authentication errors
  • INVALID_ARGUMENT, INVALID_UUID, UNSUPPORTED_CONTENT_TYPE — bad request
  • ENTRY_NOT_FOUND, DUPLICATE_ENTRY — resource errors
  • SERVICE_UNAVAILABLE, STORAGE_ERROR, INTERNAL_ERROR — server errors
Last updated on