PII Pattern Guard
text.assert_pii_free
Overview
You pass text; we check it against a fixed set of PII pattern detectors (email, phone, credit card with Luhn, IP, IBAN) and fail when any match, so you can gate publishing, logging, or sharing. A pass means no supported detector matched — not proof the text is free of all PII (names, addresses, and context-dependent identifiers are out of scope). We return counts only, never the located values. Do not use this to mask PII — use text.mask_pii. Accepts file input via file_ref — no need to extract file content first.
You need a deterministic gate that refuses to proceed when content still contains PII, with a machine-readable path to fix it (redaction) rather than a vague warning.
Reliability
BEST_EFFORT and deterministic for a fixed input and detector set: identical input always produces the same result on this deployment. Coverage is bounded to the five declared detectors — absence of matches is not proof the text contains no PII. POLICY_PII_NOT_ALLOWED — trigger: your text matched at least one enabled detector, so the gate refuses it and reports how many matches it saw; retryable: no, the same text always fails again; next: mask the values with text.mask_pii, then call us again with the masked text. Input validation (not retryable): neither text nor file_ref; both text and file_ref; text longer than 1,048,576 characters; a detectors entry that is not a string, or a detector name outside the five we know.
Context footprint
Accepts inline text up to ~1M chars or file input via file_ref (up to 2 MB). Output is counts only. Upload files via POST /v1/files/upload before passing file_ref. A successful call costs 2 execution credits.
When to use it
Before you publish, log, export, or share text that must be PII-free. Pair with text.mask_pii to auto-remediate and retry.
When you want to mask PII rather than reject it, or when you need compliance-certified or NER-based detection.
Scope
Non-goals
- Does not mask or redact PII — use text.mask_pii for that (the recovery path)
- Not exhaustive — regex-based, may miss context-dependent PII like names/addresses
- Does not use ML/NER; not a legal-compliance certification mechanism
Properties
Capabilities
Cost & billing
Flat rate per invocation
File handling
File limits
Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 1.9 MiB | Skill maximum |
How we handle your data
What this means
This skill is designed to detect, mask, redact, validate, or otherwise process sensitive data.
Squillify guarantees
- Runs inside Squillify
- This skill runs inside Squillify.
- Payloads are not sent to an external service by this skill.
- Squillify does not permanently store submitted payloads.
- Telemetry records metadata only, not submitted content.
- Submitted payloads are not used for training.
- Submitted payloads are not reviewed by humans.
- Targets sensitive data
- The response does not contain submitted content.
Your responsibility
Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| text | string | No | Bounded inline text source. Required unless file_ref is provided. |
| file_ref | string | No | Tenant-scoped opaque text-file reference. Omit it to use the required inline text; never send both. |
| detectors | array | No | Bounded optional detector selector array; omit it to enable every supported PII detector. The item shape is defined by the nested schema and the array contains from 1 through 32 items. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| piiFree | boolean | Yes | Always true for a returned successful assertion. |
| detectionCount | integer | Yes | Detected PII match count, always zero on success. |
| countsByType | object | Yes | Purpose-bound detector-type count map, empty on success. It contains from 0 through 64 detector-name count properties. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.assert_pii_free","input":{"text":"The quarterly report is ready."}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("text.assert_pii_free", {"text":"The quarterly report is ready for review."});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
| POLICY_PII_NOT_ALLOWED | 403 | No | The operation is forbidden by policy or permissions. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not mask or redact PII — use text.mask_pii for that (the recovery path)
- Not exhaustive — regex-based, may miss context-dependent PII like names/addresses
- Does not use ML/NER; not a legal-compliance certification mechanism
- Removing/masking PII — use text.mask_pii
- Compliance-grade or NER-based PII detection
- Detecting names/addresses without recognizable patterns
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "text.assert_pii_free",
"input": {
"text": "The quarterly report is ready for review."
}
}Examples
Clean text passes
{
"text": "The quarterly report is ready for review."
}{
"countsByType": {},
"piiFree": true,
"detectionCount": 0
}Re-check masked output before publishing
{
"detectors": [
"EMAIL",
"PHONE"
],
"text": "Contact [EMAIL] for details, or ring [PHONE]."
}{
"countsByType": {},
"piiFree": true,
"detectionCount": 0
}Recommended use cases
- Gate outbound content on 'no PII present' before publishing or third-party sharing
- Pre-flight check in a pipeline that must not log identifiable data
- Assert redaction succeeded by re-checking masked output
Avoid for
- Removing/masking PII — use text.mask_pii
- Compliance-grade or NER-based PII detection
- Detecting names/addresses without recognizable patterns
Related skills
Composable with
Safety & privacy
- Runs without calling any external service.
- Your payloads are never stored permanently.
- Telemetry captures metadata only — never your payload contents.
- We never train models on your payloads.
- No human reviews your payloads.