API Reference

Complete reference for the ConsentProof REST API.

Open Interactive API Docs

Base URL

All API requests should be made to:

https://api.consentproof.io

Response Format

All responses follow a consistent format:

Success Response

{
  "success": true,
  "data": {
    // Response data
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {} // Optional additional details
  }
}

Endpoints

Consent

Record and manage consent events

POST/v1/consent
GET/v1/consent/:id
GET/v1/consent/verify
GET/v1/consent/:id/pdf
POST/v1/consent/batch

Policies

Manage policy versions

POST/v1/policies
GET/v1/policies
GET/v1/policies/:id
PATCH/v1/policies/:id
DELETE/v1/policies/:id

Webhooks

Configure webhook endpoints

POST/v1/webhooks
GET/v1/webhooks
GET/v1/webhooks/:id
PATCH/v1/webhooks/:id
DELETE/v1/webhooks/:id
POST/v1/webhooks/:id/test

Common Parameters

Pagination

List endpoints support pagination with these query parameters:

ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger20Items per page (max 100)

Filtering

Many endpoints support filtering. Check individual endpoint docs for available filters.

# Filter consents by type
GET /v1/consent?consent_type=marketing&granted=true

# Filter policies by type
GET /v1/policies?type=privacy_policy&is_active=true

Rate Limits

API requests are rate limited based on your plan:

PlanRequests/minuteRequests/day
Starter601,000
Pro30050,000
Business600200,000
EnterpriseCustomCustom

Rate limit headers are included in all responses:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1705312800

Detailed Endpoint Documentation

Explore detailed documentation for each API endpoint:

Consent APIPolicies APIWebhooks API