---
seo:
  description: >-
    pii-svc exposes two endpoints: a liveness probe and a redaction endpoint.
    findings returned by POST /redact carry byte offsets into the original
    request text…
sidebar:
  label: Overview
title: PII service (pii-svc)
---
`pii-svc` exposes two endpoints: a liveness probe and a redaction endpoint.
`findings` returned by `POST /redact` carry byte offsets into the original
request `text` (`end` is exclusive); `redacted_text` is the same text with
every detected span replaced by `[ENTITY_TYPE]`.


This is a self-hosted service that ships with Webfold's data tools. Run it on your own infrastructure; a hosted endpoint on the Webfold API is not available yet. The default server below is the loopback address from the project's `docker-compose.yml`.

Version 0.1.0

Base URL: `http://127.0.0.1:7780`

## Redaction

Detect and redact personal data and secrets.

- [`POST /redact`](/docs/pii-api/redaction/redact) — Detect and redact PII in a block of text.

## System

Liveness.

- [`GET /healthz`](/docs/pii-api/system/healthz) — Liveness probe.
