Skip to main content
POST
Redact PHI from text

Authorizations

X-API-Key
string
header
required

API key for organization authentication. Obtain from the organization settings or API key management endpoint.

Body

text
string
required

Free text to redact. PHI is replaced with indexed placeholders.

Required string length: 1 - 100000
prior_mapping
object

Optional, and the preferred way to keep placeholders stable. Send back the mapping a previous call returned: a value already in it keeps its placeholder, and a new value gets the next free one. Supersedes conversation_key: if you send both, this one is used.

conversation_key
string

Deprecated in favour of prior_mapping. Supply the same value across related calls and the same source value keeps the same placeholder. It does this by deriving the placeholder from the source value itself, which makes the placeholder a code derived from information about the individual, and which cannot detect a collision across separate calls. Prefer prior_mapping.

Maximum string length: 200
return_mapping
boolean
default:true

Whether to return the placeholder→original mapping. The mapping is never stored server-side; set false if you only need redacted text and do not intend to re-identify.

Response

Redacted text plus the mapping and receipt

Documents the response shape for the schema; not used for validation.

redacted_text
string
required
mapping
object
required

placeholder → original value. Returned to YOU and never persisted by us: you own re-identification. Omitted when return_mapping=false.

entities_redacted
object
required
redaction_receipt
object
required