Skip to content

Developers

Philterd Data Services is designed to be easily integrated into your existing workflows and applications. Whether you are building a custom application, a data pipeline, or a large-scale data processing system, our API and developer tools provide the flexibility and power you need to protect sensitive information at scale.

View the Developer Quick Start to see API examples.

API Integration

The primary way for developers to interact with Philterd Data Services is through our REST API. The API provides programmatic access to all the platform's core capabilities, including:

  • Automated Redaction: Process documents and raw text for PII/PHI identification and redaction.
  • Policy Management: Create and manage your redaction policies as code.
  • Risk Assessments: Trigger and retrieve quantitative risk analysis for your data.
  • Auditability: Access cryptographic ledgers and forensic audit trails.

To get started with the API, please refer to the API Documentation.

The API and the Dashboard

Documents submitted to the API are processed in the same way as documents uploaded through the web dashboard. However, documents submitted via the API are not visible in the dashboard. This is because users of the API are likely to submit a higher volume of documents than a user who primarily uses the dashboard. Making documents submitted via the API visible in the dashboard could quickly overwhelm the user.

The API must be used to download any document that has been processed, but the API must be used to download a document that was submitted via the API.

API Authentication

All requests to the Philterd Data Services API require authentication using an API Key. You can manage your API keys in the API Keys section of your account.

Authentication is performed by including your API key in the Authorization header of every request:

Authorization: Bearer <YOUR_API_KEY>

Interactive API Reference

We provide a comprehensive and interactive API reference using Swagger UI. This allows you to explore every endpoint, understand request and response formats, and even test API calls directly from your browser.

Developer Guidelines

When building integrations with Philterd Data Services, keep the following guidelines in mind:

  • Security First: Use IP restrictions to restrict API access to your trusted infrastructure.
  • Error Handling: Your application should gracefully handle common API response codes (e.g., 401 Unauthorized, 403 Forbidden, 429 Too Many Requests).
  • Data Sovereignty: Remember that all data processing occurs within our secure environment and is never sent to third-party AI services.
  • Iterative Development: Use a separate Context for testing and development to keep your production data organized.

Need Support?

If you have technical questions or need assistance with your integration, our team is here to help. Contact us at support@philterd.ai or visit our Support page.