Documentation

Getting Started

Set up your Engrave account and start recording immutable audit events in just a few minutes.

Prerequisites

  • A valid email address
  • The ability to make HTTP requests (curl, Postman, or your programming language of choice)

Step 1: Create Your Account

Visit app.tryengrave.com/Account/Signup to create your free account. You'll receive a confirmation email to verify your address.

Once verified, your dedicated database is provisioned automatically. This typically takes less than 60 seconds.

Step 2: Generate an API Key

After logging in, navigate to API Keys in your dashboard. Click Generate New Key.

Important: Copy your API key immediately. For security, you won't be able to view it again. Store it securely and never commit it to version control.

API keys are prefixed with ek_live_ for production or ek_test_ for test environments.

Step 3: Record Your First Event

Use the REST API to record an audit event. Replace YOUR_API_KEY with your actual key.

bash 
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_registered",
    "event_timestamp": "2026-01-18T10:00:00Z",
    "metadata": {
      "user_id": "usr_12345",
      "email": "jane@example.com",
      "signup_source": "web"
    }
  }'

You'll receive a response like this:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "event_type": "user_registered",
  "event_timestamp": "2026-01-18T10:00:00Z",
  "recorded_at": "2026-01-18T10:00:05Z",
  "tx_id": 12345,
  "verification_url": "/api/v1/events/550e8400.../verify"
}

Step 4: Verify Event Integrity

At any time, you can verify that an event hasn't been modified using its verification endpoint. 

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

The response includes verified: true if the event's integrity is confirmed.

Next Steps