Getting Started

Quick start guide for integrating the Mandatry API.

1. Create an API key

  1. Sign in to the Mandatry web app
  2. Navigate to API Keys
  3. Click Create API Key
  4. Copy the key immediately (shown once)

2. Set environment variables

export MANDATRY_API_KEY="mandatry_live_<your_key>"
export MANDATRY_BASE_URL="<BASE_URL>"

3. Make your first request (Frameworks)

curl -H "X-API-Key: $MANDATRY_API_KEY" \
  "$MANDATRY_BASE_URL/frameworks-api/frameworks?jurisdiction=EU&limit=10&offset=0"

4. Compare two frameworks (Crosswalk)

curl -H "X-API-Key: $MANDATRY_API_KEY" \
  "$MANDATRY_BASE_URL/crosswalk-api?frameworks=GDPR,CCPA"

5. Version-pin a certified framework

curl -H "X-API-Key: $MANDATRY_API_KEY" \
  "$MANDATRY_BASE_URL/certified-framework/GDPR?version=v1.0"

6. Handle quotas and errors

If you exceed your organisation's monthly quota, you'll receive 429 with a JSON error payload. Review usage or upgrade your plan.

Need help?

For integration support: info@privacypartners.global