API Reference

Complete API documentation for integrating AuditGuardX into your existing systems and workflows.

Quick Start Browse Endpoints
API Navigation

Quick Start

Getting Started with the API

The AuditGuardX API is a REST API that enables you to programmatically interact with our compliance platform.

Base URL
https://api.auditguardx.com/v1
First API Call
curl -X GET \
  https://api.auditguardx.com/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Authentication

API Key Authentication

AuditGuardX uses API keys for authentication. Include your API key in the Authorization header of each request.

Getting Your API Key
  1. Log in to your AuditGuardX dashboard
  2. Navigate to Settings → API Keys
  3. Click "Generate New API Key"
  4. Copy and securely store your key
Using Your API Key
Authorization: Bearer sk_live_abcd1234567890...
Security Notice: Never expose your API keys in client-side code. Always use them from secure server environments.

API Endpoints

Available Endpoints

Endpoint Method Description
/documents GET List all documents
/documents POST Upload a new document
/documents/{id} GET Get document details
/documents/{id} DELETE Delete a document
/analysis/{document_id} GET Get compliance analysis
/analysis/{document_id} POST Trigger new analysis
/frameworks GET List compliance frameworks
/webhooks GET List webhooks
/webhooks POST Create webhook

Documents API

Upload Document

Upload a document for compliance analysis.

Request
POST /v1/documents
Content-Type: multipart/form-data

{
  "file": "document.pdf",
  "title": "Privacy Policy 2025",
  "frameworks": ["gdpr", "ccpa"]
}
Response
{
  "id": "doc_1234567890",
  "title": "Privacy Policy 2025",
  "filename": "document.pdf",
  "size": 1048576,
  "status": "processing",
  "frameworks": ["gdpr", "ccpa"],
  "uploaded_at": "2025-01-27T10:30:00Z"
}

List Documents

Retrieve a list of all uploaded documents.

Request
GET /v1/documents?limit=10&offset=0
Response
{
  "documents": [
    {
      "id": "doc_1234567890",
      "title": "Privacy Policy 2025",
      "filename": "document.pdf",
      "status": "completed",
      "compliance_score": 92,
      "uploaded_at": "2025-01-27T10:30:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0
}

Analysis API

Get Analysis Results

Retrieve compliance analysis results for a document.

Request
GET /v1/analysis/doc_1234567890
Response
{
  "document_id": "doc_1234567890",
  "overall_score": 92,
  "frameworks": {
    "gdpr": {
      "score": 94,
      "issues": [
        {
          "severity": "medium",
          "title": "Data retention period not specified",
          "description": "Consider adding specific retention periods",
          "recommendation": "Add clause specifying retention periods"
        }
      ]
    },
    "ccpa": {
      "score": 90,
      "issues": []
    }
  },
  "analyzed_at": "2025-01-27T10:35:00Z"
}

Webhooks

Webhook Events

AuditGuardX can send webhook notifications for various events.

Supported Events
  • document.uploaded - Document successfully uploaded
  • analysis.completed - Compliance analysis finished
  • analysis.failed - Analysis encountered an error
  • document.deleted - Document was deleted
Creating a Webhook
POST /v1/webhooks

{
  "url": "https://yourdomain.com/webhook",
  "events": ["analysis.completed"],
  "secret": "your_webhook_secret"
}

SDKs & Libraries

Official SDKs

Use our official SDKs to integrate AuditGuardX into your applications.

Python SDK
pip install auditguardx
Documentation
JavaScript SDK
npm install @auditguardx/sdk
Documentation
Java SDK
Maven/Gradle available
Documentation
.NET SDK
NuGet package available
Documentation

Rate Limits

API Rate Limits

API requests are rate limited to ensure fair usage and system stability.

Plan Requests per minute Requests per hour Daily uploads
Free 60 1,000 10
Professional 300 10,000 100
Enterprise 1,000 50,000 Unlimited
Rate Limit Headers
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1612137600

Need Help with Integration?

Our technical team is ready to help you integrate AuditGuardX into your systems.

Contact Technical Support Schedule API Demo