Usage¶
Send unchanged source text and inspect redacted output together with the span and validation metadata. Choose a country hint only when the source context justifies it.
Request and modes¶
The only record fields are text, optional mode and optional country_hint. Hints are auto, MX, CL, AR, DO and CO. A hint can enable bare-number matches and can also redact ordinary numbers.
| Mode | Behavior |
|---|---|
mask (default) |
Replaces detected code points with block characters. |
replace |
Uses type tags such as [MX_RFC]. |
hash |
Uses server-keyed, type-scoped HMAC pseudonyms. |
detect_only |
Returns metadata and omits redacted_text. |
Hash mode requires a server-configured LATAM_PII_HASH_KEY with at least 32 UTF-8 bytes and high entropy. Use your approved secret-management process; requests cannot supply it. Never paste it into a request, notebook or command. Pseudonyms remain linkable and are not anonymization.
Content types and bounds¶
The runtime accepts a JSON record, array, {"instances":[...]}, JSON Lines, plain text, or strict one-column CSV with exactly a text header. Arrays/envelopes and CSV return predictions; JSON Lines returns a result per nonempty line.
| Bound | Limit |
|---|---|
| HTTP body | 256 KiB of UTF-8 bytes |
| Records | 16 |
| Text per record | 16,000 Unicode code points |
| Combined text | 64,000 code points |
All records are validated before prediction; invalid input returns no partial results. Unsupported media types return 415; framing/body violations can return 400 or 413. There is one active inference at a time.
Interpret results¶
Offsets refer to the original input, start-inclusive/end-exclusive, in Unicode code points. Use text[start:end] in Python or Array.from(text).slice(start,end).join('') in JavaScript. They are not UTF-8 byte or UTF-16 indexes.
syntax_valid covers implemented structure checks. valid_checksum can be true, false or null for unknown/unverified arithmetic. issuer_verified remains false. Recognized failed, masked and unverified candidates are still redacted. Raw matched values are absent from entity metadata; secure the source and redacted outputs yourself.
Read the coverage and evaluation limits before integrating the result into a privacy workflow.
Last updated November 15, 2026 · Suggest an improvement