Tools › Entity types

Contact details

Redact street addresses from text, JSON, and CSV

Addresses are the hardest contact type to bound: a model often tags only the house number or only the street. Redactly extends the span across the whole word so the reported entity is the complete address, not a fragment.

Try it on the live API No signup. 2,000 characters, 20 runs per 10 minutes.
Output appears here.

How Redactly detects street addresses

  • Detected by the model, then the span is extended across contiguous word characters to complete partial street names.
  • A postal code the model also flags is reported separately as contact.postal_code.
  • Offsets are computed on the raw text, so line breaks do not reset character positions.

Why redact street addresses?

A full address plus a name is enough to physically locate someone, which raises the severity of any leak.

Example request

curl -X POST https://api.bitbanger.in/v1/redact \
  -H "X-API-Key: rdct_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"text": "Ship to: 214 Marlborough Road, Bristol BS8 4QA.", "style": "replace"}'

Every hit in the response carries entity, text, start, and end. The offsets index into the text you sent, so you can apply the redactions to your own copy of the document. The full response schema is in the API reference.

Questions

Does Redactly redact street addresses automatically?

Yes. Send text to the API and every detected type is redacted, including street addresses. To redact only this type, pass the value contact.address in the entities filter. No training or configuration is required.

What happens to street addresses after redaction?

With style set to replace, each match becomes [contact.address] — the entity type in square brackets. Setting style to mask replaces every character with a block character, and remove deletes the span entirely.

Related entity types

Redact street addresses in production

Get an API key and send your first request in a minute. Plans start at $24/month.

See pricing