Shielk Docs

Your first anonymization job in under 60 seconds.

Detection layers, what gets detected, jurisdiction awareness explained.

Province & industry selection, document language, anonymization modes, sample records.

Supported formats (PDF, DOCX, TXT, images with OCR), file size limits, batch processing.

Full-loop proxy setup: anonymize → AI → restore. Supported models, BYOAPI, multi-turn conversations.

What the compliance PDF contains, provincial citations, compliance certificate download.

Token reuse across sessions, session persistence, resetting tokens.

Reporting false positives and false negatives, user feedback training loop.

French NLP support, language auto-detection, Law 25 compliance, RAMQ/QC entities.

Install and configure Chrome, Firefox, Word, and Outlook add-ins. API key activation.

/shield command in Slack, @Shielk in Teams, workspace installation.

11 specialized modules — healthcare, legal, financial, government, and more.

Subscription tiers, API key management, team seats, billing portal.

Base URL: shield.canuckt.ai/api/v1. Authenticate with X-API-Key header. First call in 2 minutes.

API key management, header format (X-API-Key), OAuth 2.0 support for integrations.

Anonymize text. Body: { text, jurisdiction, industry, language, consistent }. Returns job_id, anonymized_text, entities[].

Restore real values. Body: { text, session_id }. Returns restored_text, replacements_made.

Upload PDF, DOCX, or image. Multipart form-data. Returns job_id and estimated_seconds.

Poll job status (pending | processing | complete | failed). Returns anonymized_text, entity_count, session_id.

Download the PIPEDA compliance PDF for a completed job.

8 categories: Identity, Health, Financial, Location, Contact, Legal, Professional, Indigenous. Full list with codes.

Free: no API. Pro: 20 req/min, 10K/month. Agency: 100 req/min, 50K/month, 10MB per file.

400 bad request, 401 unauthorized, 403 plan limit, 413 file too large, 429 rate limited, 500 engine error.

Self-host Shielk using the official Docker image. Air-gapped support. Agency plan only.

Returns { status: "healthy", engine: "running", recognizers: 421, modules_loaded: 11 }.