Skip to content

API Methods

The Philterd Data Services API provides several categories of endpoints to help you manage your data privacy and security needs. All API requests require authentication using an API key.

For a complete and interactive list of all available API endpoints, including request and response schemas, please refer to our Swagger and OpenAPI documentation:

Text Redaction

Redact sensitive information from plain text. You can specify a redaction policy and a context to control how the text is processed and to ensure consistency across multiple requests.

  • Redact Text: POST /api/redact

Document Redaction

Upload and redact files in various formats (e.g., PDF, DOCX, images). The API supports tracking the status of redaction tasks, downloading redacted files, and retrieving redaction summaries.

  • Upload and Redact Document: POST /api/documents
  • Get Documents: GET /api/documents
  • Get Redaction Status: GET /api/documents/{documentId}
  • Download Redacted Document: GET /api/documents/{documentId}/download
  • Get Redaction Summary: GET /api/documents/{documentId}/summary
  • Delete Document: DELETE /api/documents/{documentId}

Redaction Contexts

Manage redaction contexts to group related tasks and ensure cryptographic consistency (e.g., for consistent anonymization).

  • Get Contexts: GET /api/contexts
  • Create Context: POST /api/contexts/{context}
  • Delete Context: DELETE /api/contexts/{context}

Redaction Policies

Manage the policies that define what sensitive information to redact and how to redact it.

  • Get Policies: GET /api/policies
  • Get Policy: GET /api/policies/{policyName}
  • Save/Update Policy: POST /api/policies/{policyName}
  • Delete Policy: DELETE /api/policies/{policyName}

Risk Assessments

Perform risk assessments on documents to identify potential privacy risks and sensitive information density.

  • Get Risk Assessments: GET /api/risk-assessments
  • Get Risk Assessment: GET /api/risk-assessments/{documentId}
  • Redact with Risk Assessment: POST /api/risk-assessments

Ledgers

Retrieve the audit trail of redactions performed on documents.

  • Get Ledgers: GET /api/ledger
  • Get Document Ledger: GET /api/ledger/{documentId}
  • Delete Ledger: DELETE /api/ledger/{documentId}