# AuditRails

## Docs

- [Welcome to AuditRails — Tamper-Proof Audit Logging](https://docs.auditrails.io/introduction.md): AuditRails delivers tamper-proof audit logging with SHA-256 hash chains, WORM storage, and built-in compliance coverage for SOC 2, HIPAA, and PCI DSS.
- [Quickstart: Log Your First Audit Event in 5 Minutes](https://docs.auditrails.io/quickstart.md): Create a free AuditRails account, install your language's SDK, and send your first tamper-proof audit event in under five minutes. No credit card required.
- [Core Concepts: Events, Hash Chains, and AuditRails Storage](https://docs.auditrails.io/concepts.md): Understand how AuditRails structures organizations, projects, events, hash chains, dual-tier storage, and plan-based retention policies.
- [Authentication — API Keys and Security Best Practices](https://docs.auditrails.io/authentication.md): Authenticate AuditRails API requests with a Bearer token. Learn key formats, secure SDK initialization, and how to handle auth errors.
- [Compliance Framework Mapping: SOC 2, HIPAA, GDPR, and More](https://docs.auditrails.io/guides/compliance-mapping.md): Map AuditRails events and features to all 18 supported compliance frameworks, including SOC 2, HIPAA, PCI DSS v4.0, GDPR, NIS2, DORA, and more.
- [Hash Chain Verification: Tamper-Proof Audit Log Integrity](https://docs.auditrails.io/guides/hash-chain-verification.md): Understand how AuditRails SHA-256 hash chaining makes audit logs tamper-proof, and how to verify chain integrity via the dashboard or API.
- [Data Retention Policies, Storage Tiers, and WORM Archiving](https://docs.auditrails.io/guides/data-retention.md): Learn how AuditRails' two-tier storage architecture, plan-based retention periods, WORM archiving, and DSAR handling keep your audit logs compliant.
- [GDPR Compliance Guide: DPA, DSARs, Data Residency, and PII](https://docs.auditrails.io/guides/gdpr-compliance.md): Set up AuditRails as a GDPR-compliant data processor: sign your DPA, handle DSARs, anonymise IPs, apply redaction rules, and configure data residency.
- [Event Schema Reference: Input, Enriched & Chain Fields](https://docs.auditrails.io/reference/event-schema.md): Complete reference for AuditRails event fields — what you send, what gets enriched, and how tamper-proof chain fields are computed.
- [AuditRails Error Codes: Complete API Error Reference](https://docs.auditrails.io/reference/error-codes.md): Complete reference for every AuditRails API error code — its HTTP status, root cause, and the exact resolution steps to fix your integration.
- [AuditRails Rate Limits: Quotas and Throttling Rules](https://docs.auditrails.io/reference/rate-limits.md): How AuditRails rate limiting works, which limits apply to your plan and key type, how to handle 429 responses, and tips for high-throughput logging.
- [AuditRails API Overview: Endpoints and Conventions](https://docs.auditrails.io/api-reference/overview.md): A complete reference for the AuditRails REST API — ingest events, query audit logs, verify chain integrity, and explore the compliance action catalog.
- [AuditRails API Authentication: Bearer Tokens & Keys](https://docs.auditrails.io/api-reference/authentication.md): Authenticate every AuditRails API request with a Bearer token. Learn key types, security best practices, and how to handle auth errors.
- [AuditRails API Rate Limits: Tiers, 429 & Retry Logic](https://docs.auditrails.io/api-reference/rate-limits.md): Understand AuditRails' three-tier rate limiting model, how 429 responses work, and how to build clients that handle limits gracefully.
- [Log a Single Tamper-Proof Audit Event — POST /v1/events](https://docs.auditrails.io/api-reference/post-events.md): Append a single tamper-proof audit log entry to your AuditRails stream. Accepts an action, actor, resource, and arbitrary metadata.
- [Log Up to 100 Audit Events — POST /v1/events/batch](https://docs.auditrails.io/api-reference/post-events-batch.md): Append up to 100 audit log entries in a single atomic request. The entire batch is accepted or rejected together — no partial writes.
- [List Audit Log Events — AuditRails API Reference](https://docs.auditrails.io/api-reference/get-events.md): Retrieve a paginated, newest-first list of audit log events. Filter by action, actor, resource, or date range using cursor-based pagination.
- [Get Single Audit Event — AuditRails API Reference](https://docs.auditrails.io/api-reference/get-event.md): Fetch complete details of a single audit log event by its ULID log_id, including all hash chain fields for independent tamper verification.
- [Verify Audit Hash Chain — AuditRails API Reference](https://docs.auditrails.io/api-reference/verify-chain.md): Cryptographically verify the tamper-evident SHA-256 hash chain across a range of audit log events to detect unauthorized modifications.
- [Browse the Action Catalog — AuditRails API Reference](https://docs.auditrails.io/api-reference/actions.md): Browse the compliance action catalog to discover supported event types, their required metadata fields, and which regulatory frameworks they satisfy.
- [DSAR Export — GDPR Right of Access and Data Portability](https://docs.auditrails.io/api-reference/dsar-export.md): Submit a Data Subject Access Request to export all audit events for a given actor, satisfying GDPR Articles 15 and 20 obligations.
- [DSAR Delete — Right to Erasure (Right to Be Forgotten)](https://docs.auditrails.io/api-reference/dsar-delete.md): Submit a Data Subject deletion request to erase all audit events for a given actor from AuditRails hot storage, in line with GDPR Article 17.
- [AuditRails SDK Overview — Client Libraries & Packages](https://docs.auditrails.io/sdks/overview.md): Official AuditRails SDKs for Node.js, Python, Go, Java, and PHP. Automatic batching, exponential-backoff retries, and graceful shutdown built in.
- [Node.js & TypeScript SDK — AuditRails Audit Client](https://docs.auditrails.io/sdks/node.md): Integrate AuditRails into any Node.js or TypeScript application. Zero dependencies, native fetch, automatic batching, and full TypeScript types included.
- [Python SDK — AuditRails Sync and Async Audit Client](https://docs.auditrails.io/sdks/python.md): Integrate AuditRails into any Python application. Sync and async clients, zero dependencies for sync, Django and FastAPI integration examples included.
- [Go SDK — AuditRails Context-Aware Audit Log Client](https://docs.auditrails.io/sdks/go.md): Integrate AuditRails into any Go application. Zero dependencies, context-aware logging, automatic batching, and structured logging via slog.
- [Java SDK — AuditRails Audit Logging and Integration](https://docs.auditrails.io/sdks/java.md): Integrate AuditRails into any Java application. Zero dependencies, builder pattern, Spring Boot autoconfiguration, and AutoCloseable for safe shutdown.
- [PHP SDK — AuditRails Composer Audit Logging Client](https://docs.auditrails.io/sdks/php.md): Integrate AuditRails into any PHP application. PSR-18 compatible, Laravel-ready, automatic batching, and PSR-3 logger support out of the box.