Developer Documentation

Complete API reference, integration guides, and implementation examples for building compliance monitoring into your applications.

REST API v1.0
SDKs Available
Webhook Support

Quick Start

Get started with the Compliance API in minutes

Authentication

All API requests require authentication using API keys

Authorization: Bearer your-api-key

Get your API key from the dashboard settings page

Rate Limits

API usage limits based on your subscription tier

Free: 10 requests/hour
Pro: 100 requests/hour
Enterprise: 1000 requests/hour

API Reference

Complete REST API endpoints for compliance scanning

POST
/api/scans
Details

Trigger a new compliance scan

Parameters: url, regulations[]

GET
/api/scans/{id}
Details

Get scan results and status

Parameters: scan_id

GET
/api/scans
Details

List all scans for authenticated user

Parameters: limit, offset

POST
/api/webhooks/results
Details

Receive scan completion notifications

Parameters: callback_url, events[]

Code Examples

Implementation examples in popular languages

JavaScript

import { ComplianceAPI } from '@compliance/sdk';

const client = new ComplianceAPI({
  apiKey: 'your-api-key'
});

const scan = await client.scans.create({
  url: 'https://example.com',
  regulations: ['GDPR', 'CCPA']
});

console.log('Scan ID:', scan.id);

Python

from compliance_api import ComplianceClient

client = ComplianceClient(api_key='your-api-key')

scan = client.scans.create(
    url='https://example.com',
    regulations=['GDPR', 'CCPA']
)

print(f'Scan ID: {scan.id}')

curl

curl -X POST https://api.compliancecheck.com/v1/scans \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "regulations": ["GDPR", "CCPA"]
  }'

Integration Guides

Step-by-step guides for common integration scenarios

Popular

N8N Workflow Integration

Connect compliance scanning to your automated workflows

DevOps

CI/CD Pipeline Integration

Automated compliance checks in your deployment pipeline

Real-time

Webhook Configuration

Real-time notifications for scan completion and alerts

Frontend

Dashboard Embedding

Embed compliance status widgets in your applications

Supported Regulations

Comprehensive coverage of global privacy regulations

GDPR

Supported

European General Data Protection Regulation

Consent management, data subject rights, breach notification, cookie compliance

CCPA/CPRA

Supported

California Consumer Privacy Act & Amendment

Consumer rights, opt-out mechanisms, data sale disclosures, sensitive data handling

China PIPL

Supported

Personal Information Protection Law

Cross-border transfers, consent requirements, data localization compliance

US State Laws

Supported

25+ State Privacy Regulations

VCDPA, CPA, CTDPA, UCPA, TDPSA, and emerging state privacy laws

API Reference

Interactive API documentation with examples

SDKs & Libraries

Official SDKs for JavaScript, Python, PHP, and more

Compliance Guide

Understanding regulations and implementation best practices

Start Building with Our API

Get your API key and start integrating compliance monitoring today