API Endpoint

POST PII Redaction API

/api/v1/ai/pii-redaction

Automatically detect and securely scrub Personally Identifiable Information (PII) from text to maintain GDPR, HIPAA, and general data compliance.

Request Body Parameters

Field	Type	Required	Description
`text`	string	Required	The raw text to be sanitized (Max: 10,000 characters).
`redact_types`	array of strings	Optional	Specific types to redact. Allowed: `names`, `emails`, `phone_numbers`, `credit_cards`, `ssn`, `addresses`, `passwords`, `ip_addresses`. If empty, redacts all high-risk PII.
`redaction_style`	string	Optional	How to mask the data. `placeholder` (e.g., [EMAIL]), `asterisk` (e.g., j***@gmail.com), or `scramble`. Default is `placeholder`.
`return_entities`	boolean	Optional	Optional. If true, returns an analytics array summarizing the types of PII detected and redacted.
`model`	string	Optional	Optional AI model to use.

Example Request (Selective Redaction)

In this example, we ask the API to specifically target and asterisk-out credit cards and emails, while safely ignoring names or other data.

JSON Request

{
  "text": "Hey, it's Jane Smith. Please update my billing. My new card is 4111-2222-3333-4444 and my receipt email is jane.smith99@example.com. Thanks!",
  "redact_types": ["credit_cards", "emails"],
  "redaction_style": "asterisk",
  "return_entities": true
}

cURL

curl -X POST https://rsflowhub.com/api/v1/ai/pii-redaction \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hey, it'\''s Jane Smith. Please update my billing. My new card is 4111-2222-3333-4444 and my receipt email is jane.smith99@example.com. Thanks!",
    "redact_types": ["credit_cards", "emails"],
    "redaction_style": "asterisk",
    "return_entities": true
  }'

Example Response

The API safely sanitizes the requested fields. Notice how "Jane Smith" was intentionally ignored because `names` was not included in the `redact_types` array. The `entities_redacted` array securely provides analytics without exposing the raw strings.

JSON Response

{
  "success": true,
  "data": {
    "result": {
      "redacted_text": "Hey, it's Jane Smith. Please update my billing. My new card is ****-****-****-4444 and my receipt email is j***@example.com. Thanks!",
      "entities_redacted": [
        {
          "type": "CREDIT_CARD",
          "count": 1
        },
        {
          "type": "EMAIL",
          "count": 1
        }
      ]
    }
  },
  "meta": {
    "credits_used": 2,
    "credits_remaining": 986
  }
}

API Request Example

Use the cURL snippet below to test the endpoint.