{
  "id": "pii-redact",
  "name": "Redact common PII patterns",
  "description": "Use as a review aid before inspecting logs or sample text. Replaces selected ASCII email, formatted US phone, XXX-XX-XXXX SSN-shaped, and valid dotted IPv4 patterns with fixed labels; returns original-source offsets without match values. Phone patterns require separators; SSN patterns do not validate issuance. Non-exhaustive heuristics can miss PII and produce false positives. Never a security, compliance, or anonymization guarantee. Maximum 10,000 matches.",
  "category": "text",
  "priceUsd": "0.005",
  "pricingStatus": "proposed-unverified",
  "pricing": {
    "unit": "one successful operation call",
    "proposedNominalUsd": "0.005",
    "sixDecimalTokenBaseUnits": "5000",
    "subscription": false,
    "includesPayerWalletOrNetworkFees": false,
    "liveQuoteVerified": false,
    "condition": "Actual SDK challenge is authoritative only within the caller's explicit authorization; configured six-decimal token peg is an operator assertion, not a conversion guarantee."
  },
  "intents": [
    "redact common personal data patterns",
    "mask email phone SSN IPv4"
  ],
  "whenToUse": [
    "Aid review by masking a bounded set of common ASCII patterns."
  ],
  "whenNotToUse": [
    "Complete anonymization, legal compliance, or exhaustive PII detection."
  ],
  "capabilities": [
    "pii-redact",
    "redact common personal data patterns",
    "mask email phone SSN IPv4"
  ],
  "related": [
    "text-chunk"
  ],
  "limits": {
    "requestBytes": 131072,
    "responseBytes": 524288,
    "jsonDepth": 32
  },
  "errorCodes": [
    "INVALID_INPUT",
    "INPUT_TOO_LARGE",
    "OUTPUT_TOO_LARGE"
  ],
  "requirementsProfile": {
    "format": "declared-requirements-v1",
    "facts": {
      "execution.suppliedCode": false,
      "execution.remoteMutation": false,
      "execution.llmInference": false,
      "execution.paidMcp": false,
      "verification.semanticTruth": false,
      "verification.sourceAuthenticity": false,
      "verification.liveVulnerabilities": false,
      "numbers.arbitraryPrecisionJson": false,
      "numbers.model": "ieee754-binary64",
      "privacy.requestBodyPersisted": false,
      "execution.deterministic": true,
      "execution.networkAccess": false,
      "privacy.resultBodyPersisted": false,
      "payment.x402": true,
      "payment.mpp": true,
      "operation.id": "pii-redact",
      "operation.category": "text",
      "limit.httpRequestBytes": 131072,
      "limit.requestBytes": 131072,
      "limit.responseBytes": 524288,
      "limit.resultBytes": 523264,
      "limit.jsonDepth": 32,
      "limit.jsonNodes": 20000,
      "privacy.completePiiRemoval": false,
      "privacy.heuristicPiiPatterns": true,
      "input.text.maxLength": 100000,
      "input.types.maxItems": 4,
      "input.types.minItems": 1
    },
    "unknownPolicy": "Undeclared requirements are unknown, never compatible. Matching declared facts does not establish semantic fit or input validity.",
    "preflight": "/preflight"
  },
  "documentation": "/reference/tools/pii-redact.md",
  "serviceContract": "/reference/services/pii-redact.json",
  "errors": [
    {
      "status": 400,
      "meaning": "Malformed JSON, missing/invalid idempotency key, or payment identifier mismatch",
      "retry": "Correct the request before payment"
    },
    {
      "status": 402,
      "meaning": "Payment challenge or rejected payment",
      "retry": "Use official protocol SDK; inspect payment outcome before another payment"
    },
    {
      "status": 409,
      "meaning": "Idempotency conflict, duplicate proof, or PAYMENT_UNCERTAIN",
      "retry": "Keep original key, body, and proof; reconcile uncertainty with operator; never blindly repay"
    },
    {
      "status": 413,
      "meaning": "Input or generated output too large",
      "retry": "Reduce input; no payment attempted for validation failure"
    },
    {
      "status": 415,
      "meaning": "Unsupported media type or compression",
      "retry": "Send uncompressed application/json"
    },
    {
      "status": 422,
      "meaning": "Schema or service-specific semantic validation failure",
      "retry": "Correct input using returned error code; no payment attempted"
    },
    {
      "status": 429,
      "meaning": "Request/payment-attempt rate exceeded",
      "retry": "Wait for rate limit window; preserve existing payment identity"
    },
    {
      "status": 503,
      "meaning": "Payment configuration/provider/state unavailable, or live DNS preparation failed before settlement",
      "retry": "Check readiness; DNS preparation failures may retry the identical key/body/credential only; uncertainty requires reconciliation"
    }
  ],
  "numericPrecision": "JavaScript IEEE-754 numbers; use strings for large integer IDs/exact decimals where the schema accepts strings. No lossless numeric parsing.",
  "paymentWorkflow": {
    "discoveryOnly": false,
    "supportedProtocols": [
      "x402",
      "mpp"
    ],
    "x402": {
      "credentialHeader": "PAYMENT-SIGNATURE",
      "challengeHeader": "PAYMENT-REQUIRED",
      "receiptHeader": "PAYMENT-RESPONSE",
      "version": 2,
      "scheme": "exact",
      "paymentIdentifier": "payment-identifier extension MUST equal the HTTP Idempotency-Key",
      "sdk": "@x402/core with @x402/evm"
    },
    "mpp": {
      "supported": true,
      "credentialHeader": "Authorization",
      "challengeHeader": "WWW-Authenticate",
      "receiptHeader": "Payment-Receipt",
      "method": "tempo",
      "intent": "charge",
      "sdk": "mppx",
      "tokenDecimals": 6
    },
    "steps": [
      "Check configured readiness and the exact service schema",
      "Generate a fresh random Idempotency-Key for this operation; never use a discovery probe fixture for purchases",
      "Send valid input without a credential to obtain the official protocol challenge",
      "Use the official SDK and authorized wallet to fulfill the challenge",
      "Retry only with identical key, body, protocol and credential",
      "On PAYMENT_UNCERTAIN stop and request operator reconciliation; never blindly pay again"
    ],
    "versionedRetries": "Request fingerprint includes service release version. Retries across a version upgrade can conflict; coordinate upgrades outside the 24-hour replay window and reconcile pending attempts.",
    "docs": "/llms.txt"
  },
  "method": "POST",
  "paths": {
    "x402": "/v1/x402/pii-redact",
    "mpp": "/v1/mpp/pii-redact"
  },
  "inputSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "text": {
        "type": "string",
        "maxLength": 100000
      },
      "types": {
        "default": [
          "email",
          "us-phone"
        ],
        "minItems": 1,
        "maxItems": 4,
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "email",
            "us-phone",
            "us-ssn",
            "ipv4"
          ]
        }
      }
    },
    "required": [
      "text"
    ],
    "additionalProperties": false
  },
  "outputSchema": {
    "type": "object",
    "required": [
      "operation",
      "version",
      "result",
      "provenance"
    ],
    "properties": {
      "operation": {
        "const": "pii-redact",
        "type": "string"
      },
      "version": {
        "const": "0.29.0",
        "type": "string"
      },
      "result": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "maxLength": 300000
          },
          "offsetUnit": {
            "type": "string",
            "const": "UTF-16 code units; zero-based, end-exclusive"
          },
          "count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000
          },
          "counts": {
            "type": "object",
            "properties": {
              "email": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10000
              },
              "usPhone": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10000
              },
              "usSsn": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10000
              },
              "ipv4": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10000
              }
            },
            "required": [
              "email",
              "usPhone",
              "usSsn",
              "ipv4"
            ],
            "additionalProperties": false
          },
          "redactions": {
            "maxItems": 10000,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "email",
                    "us-phone",
                    "us-ssn",
                    "ipv4"
                  ]
                },
                "start": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 100000
                },
                "end": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 100000
                },
                "replacement": {
                  "type": "string",
                  "enum": [
                    "[EMAIL]",
                    "[US_PHONE]",
                    "[US_SSN]",
                    "[IPV4]"
                  ]
                }
              },
              "required": [
                "type",
                "start",
                "end",
                "replacement"
              ],
              "additionalProperties": false
            }
          },
          "warning": {
            "type": "string",
            "const": "Pattern-only redaction is non-exhaustive and can miss personal data or redact non-personal text. Do not rely on it as a security, compliance, or anonymization guarantee."
          }
        },
        "required": [
          "text",
          "offsetUnit",
          "count",
          "counts",
          "redactions",
          "warning"
        ],
        "additionalProperties": false
      },
      "provenance": {
        "type": "object",
        "required": [
          "inputSha256",
          "outputSha256",
          "deterministic",
          "externalRequests"
        ],
        "properties": {
          "inputSha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "outputSha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "deterministic": {
            "const": true
          },
          "externalRequests": {
            "const": 0
          }
        }
      }
    },
    "additionalProperties": false
  },
  "exampleInput": {
    "text": "Email alex@example.com or call (415) 555-2671. Host: 192.168.1.20",
    "types": [
      "email",
      "us-phone",
      "ipv4"
    ]
  },
  "exampleResponse": {
    "operation": "pii-redact",
    "version": "0.29.0",
    "result": {
      "text": "Email [EMAIL] or call [US_PHONE]. Host: [IPV4]",
      "offsetUnit": "UTF-16 code units; zero-based, end-exclusive",
      "count": 3,
      "counts": {
        "email": 1,
        "usPhone": 1,
        "usSsn": 0,
        "ipv4": 1
      },
      "redactions": [
        {
          "type": "email",
          "start": 6,
          "end": 22,
          "replacement": "[EMAIL]"
        },
        {
          "type": "us-phone",
          "start": 31,
          "end": 45,
          "replacement": "[US_PHONE]"
        },
        {
          "type": "ipv4",
          "start": 53,
          "end": 65,
          "replacement": "[IPV4]"
        }
      ],
      "warning": "Pattern-only redaction is non-exhaustive and can miss personal data or redact non-personal text. Do not rely on it as a security, compliance, or anonymization guarantee."
    },
    "provenance": {
      "inputSha256": "0d19138edb2e9fa39d38a91b2e8c426bca6d4a4d1835907c24f4870e848417b1",
      "outputSha256": "6fee41bce2920ef0b94b502c04da6a3d876729b5195cade74c92883778ff91a2",
      "deterministic": true,
      "externalRequests": 0
    }
  },
  "requiredHeaders": {
    "Content-Type": "application/json",
    "Idempotency-Key": "random 16–128 character operation identifier"
  },
  "fixedExample": "/reference/examples/pii-redact.json",
  "execution": {
    "deterministic": true,
    "externalRequests": 0,
    "maxExternalRequests": 0,
    "resultSnapshotPersisted": false,
    "fixedExampleIsIllustrativeSnapshot": false,
    "requiresPayment": true,
    "supportsMcpExecution": false
  },
  "releaseSnapshot": {
    "format": "static-release-reference-v1",
    "sourceVersion": "0.29.0",
    "sourceRegistrySha256": "a2b5ec09bf6c38b9d2879d746a4fded374f5928b445377b0270ef6aa8e6cac65",
    "generatedAt": "2026-10-06T15:38:00Z",
    "releaseAcceptance": "not-verified-by-generator",
    "runtimeReadiness": "not-evaluated",
    "livePaymentsVerified": false,
    "indexingVerified": false,
    "apiOrigin": null,
    "notice": "Build-time release reference. Runtime readiness, deployment, payment settlement and external indexing are not evaluated here. Prices are proposed; this file cannot authorize execution or payment."
  }
}