API Documentation

Endpoint: Grade Transparency of Privacy Policy

This endpoint assesses the transparency of a submitted privacy policy URL.

POST /api/grade/transparency

Submits a privacy policy URL for grading.

Headers

Content-Type: application/json
X-API-KEY: {your_api_key}

Request Body

{
    "policyUrl": "https://example.com/your-privacy-policy-url"
}

Response

200 OK: The request was successful, and the response contains the grade and summary.

{
    "grade": "A",
    "summary": "The privacy policy is well-structured and transparent."
}

Sample Call

curl -X POST https://katz.ppgs.global/api/grade/transparency \
     -H "Content-Type: application/json" \
     -H "X-API-KEY: your_api_key" \
     -d '{"policyUrl": "https://example.com/your-privacy-policy-url"}'