Usage

The Consent Directory API allows developers, consent managers, and compliance systems to seamlessly integrate standardized consent purpose statements, data elements, and compliance metadata aligned with the Digital Personal Data Protection Act (DPDPA), 2023. It is designed to simplify consent management, interoperability, and audit readiness across platforms.

🔧 Base URL

https://api.consentfoundation.org/v1

All API requests must be made over HTTPS. Authentication is handled through API keys issued by the Consent Foundation.

Authentication

Include your API key in the request header:

Authorization: Bearer <your_api_key>

API Endpoints

🧩 Base URL

https://api.consentfoundation.org/v1

---

🔑 Authentication

All endpoints require an API key. Include it in the request header:

Authorization: Bearer <your_api_key>

---

1. 🔹 Search by Industry, Category, and Data Element

GET /search

Description

Retrieve standardized consent purposes filtered by industry, category, or data element. Useful for CMPs and compliance systems to dynamically populate sector-specific or activity-based purposes.

Query Parameters

Name	Type	Required	Description
industry	string	Optional	Filter by industry sector, e.g. finance, insurance, healthcare, telecom
category	string	Optional	Filter by purpose category, e.g. marketing, onboarding, analytics, kyc
data_element	string	Optional	Search purposes involving specific data elements like email, PAN, or biometric
language	string	Optional	ISO language code (default: en)
limit	integer	Optional	Results per page (default: 20)
page	integer	Optional	Page number (default: 1)

Example Request

GET /search?industry=finance&data_element=PAN&category=kyc&language=en

Example Response

{
  "status": "success",
  "results": [
    {
      "purpose_id": "FIN-KYC-001",
      "industry": "finance",
      "category": "kyc",
      "title": "For processing of PAN and identity documents for account verification",
      "language": "en",
      "data_elements": ["PAN", "Aadhaar", "name", "address"],
      "regulatory_reference": "RBI/DPDPA-2023",
      "retention_period": "7 years"
    },
    {
      "purpose_id": "FIN-KYC-002",
      "industry": "finance",
      "category": "kyc",
      "title": "To verification of financial records for loan processing",
      "language": "en",
      "data_elements": ["income", "bank_statement"],
      "regulatory_reference": "RBI/DPDPA-2023",
      "retention_period": "7 years"
    }
  ]
}

---

Search by Statement or keywords

POST /search/{statement, keywords etc}

Description

Search for the closest standardized consent purpose by submitting a free-text consent statement. This endpoint uses semantic similarity and keyword mapping to identify the best-matching purpose under DPDPA.

Request Body

{
  "statement": "We seek your consent to process your personal data for insurance claim settlement.",
  "industry": "insurance",
  "language": "en"
}

Response

{
  "status": "success",
  "matches": [
    {
      "purpose_id": "INS-CLAIM-004",
      "similarity_score": 0.96,
      "title": "Processing personal data for insurance claim assessment and settlement",
      "description": "Consent to process policyholder data including identity and claim documents for claim verification and settlement.",
      "data_elements": ["name", "policy_number", "claim_documents"],
      "language": "en",
      "regulatory_reference": "IRDAI/DPDPA-2023"
    }
  ],
  "recommendation": "Use standardized purpose INS-CLAIM-004 to ensure DPDPA-compliant consent wording."
}

Error Response

Standard error format for all endpoints:

{
  "status": "error",
  "code": 400,
  "message": "Missing parameter: statement"
}

Developer Notes

• Versioning: All APIs follow semantic versioning. Current version: v1.

• Rate Limits: 500 requests per minute per API key.

• Error Handling: Standard error response:

  {
    "status": "error",
    "code": 400,
    "message": "Invalid parameter: sector"
  }