API Documentation

The PackComply API enables you to programmatically access our AI-driven packaging compliance auditing system. Our API helps you ensure your products meet EU Packaging & Packaging Waste Regulation (PPWR) requirements across all EU member states.

PackComply uses API key authentication. Include your API key in the Authorization header of all requests.

Getting Your API Key

1. Log in to your PackComply dashboard at app.packcomply.com
2. Navigate to Settings → API Keys
3. Click "Generate New API Key"
4. Copy and securely store your API key

Authentication Header

Authorization: Bearer YOUR_API_KEY_HERE

Example Authentication

curl -X GET "https://api.packcomply.com/api/v1/audits" \
  -H "Authorization: Bearer pc_live_abc123..." \
  -H "Content-Type: application/json"

const response = await fetch('https://api.packcomply.com/api/v1/audits', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer pc_live_abc123...',
    'Content-Type': 'application/json'
  }
});

Webhooks allow you to receive real-time notifications when audit processes complete. This enables you to automatically trigger downstream processes without polling our API.

Setting Up Webhooks

Configure webhooks in your PackComply dashboard or programmatically via the API:

{
  "url": "https://your-api.com/packcomply-webhook",
  "events": ["audit.completed", "audit.failed"],
  "secret": "your_webhook_secret_key"
}

Webhook Events

Example Webhook Payload

{
  "event": "audit.completed",
  "audit_id": "audit_xyz789",
  "audit_name": "Q1 2024 PPWR Compliance Check",
  "status": "completed",
  "summary": {
    "total_items": 1,
    "compliant_items": 0,
    "non_compliant_items": 1,
    "compliance_rate": "0%"
  },
  "completed_at": "2024-01-15T10:37:00Z",
  "webhook_id": "wh_abc123"
}

Webhook Security

All webhook requests include a signature in the X-PackComply-Signature header. Verify this signature using your webhook secret to ensure the request came from PackComply.

// Node.js webhook verification example
const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature, 'hex'),
    Buffer.from(expectedSignature, 'hex')
  );
}

PackComply uses conventional HTTP response codes to indicate the success or failure of API requests.

HTTP Status Codes

Error Response Format

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters",
    "details": [
      {
        "field": "target_countries",
        "message": "Must be an array of valid ISO 3166-1 alpha-2 country codes"
      }
    ],
    "request_id": "req_abc123"
  }
}

Common Error Types

To ensure fair usage and optimal performance, PackComply implements rate limits and monthly quotas based on your subscription plan.

Rate Limits

Monthly Quotas

Rate Limit Headers

All API responses include headers to help you track your current usage:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642176000
X-Quota-Limit: 10000
X-Quota-Remaining: 9850
X-Quota-Reset: 1644768000

PackComply takes security and data privacy seriously. All API communications are encrypted and we follow industry best practices for data protection.

Security Features

Data Retention

Compliance