Documentation

Everything you need to integrate Engrave's immutable audit evidence platform into your applications.

Quick Start

Get up and running with Engrave in 5 minutes.

1 Create Your Account

Sign up for a free account. Your dedicated database is provisioned automatically.

2 Get Your API Key

Navigate to the API Keys section in your dashboard and generate a new API key. Keep this key secure - you'll need it for all API requests. 

# Your API key looks like this:
API_KEY=ek_live_abc123def456...

3 Record Your First Event

Use the REST API to record an audit event. Include any metadata relevant to your use case.

Record an event 
curl -X POST https://api.tryengrave.com/api/v1/events \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "user_signup",
    "metadata": {
      "user_id": "usr_12345",
      "email": "user@example.com"
    }
  }'

4 Verify Integrity

Use the verification endpoint to cryptographically prove the event hasn't been modified. 

curl https://api.tryengrave.com/api/v1/events/{id}/verify \
  -H "X-API-Key: YOUR_API_KEY"

# Response:
{
  "verified": true,
  "tx_id": 12345,
  "hash_matches": true
}

Explore the Documentation

Getting Started

Step-by-step guide to set up your account and record your first event.

API Reference

Complete documentation of all REST API endpoints.

SDKs

Official client libraries for .NET and TypeScript.

API Overview

Base URL

https://api.tryengrave.com

Authentication

All API requests require an API key passed in the X-API-Key header.

X-API-Key: ek_live_your_api_key_here

Core Endpoints

POST /api/v1/events Record new audit event
GET /api/v1/events List/search events
GET /api/v1/events/{id} Get event details
GET /api/v1/events/{id}/verify Verify event integrity
POST /api/v1/events/{id}/evidence Upload evidence
GET /api/v1/evidence/{id} Download evidence
View full API reference →

Ready to Get Started?

Create your free account and start recording audit events today.

Start Free Trial