PII Redaction (Vietnam) API

Find and mask personal data in Vietnamese text: CCCD, tax codes, phones, bank accounts, cards, emails, BHYT, plates, names, addresses. Spans reported.

Parameters

Example

curl -X POST "https://apibox.io.vn/v1/vn-pii-redact" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Khách hàng Nguyễn Văn An, CCCD 079203001234, SĐT 0909 123 456, email an.nguyen@gmail.com, STK VCB 0071000123456.","mode":"mask"}'

const res = await fetch('https://apibox.io.vn/v1/vn-pii-redact', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "text": "Khách hàng Nguyễn Văn An, CCCD 079203001234, SĐT 0909 123 456, email an.nguyen@gmail.com, STK VCB 0071000123456.",
    "mode": "mask"
  }),
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    "https://apibox.io.vn/v1/vn-pii-redact",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"text": "Khách hàng Nguyễn Văn An, CCCD 079203001234, SĐT 0909 123 456, email an.nguyen@gmail.com, STK VCB 0071000123456.", "mode": "mask"},
    timeout=30,
)
print(res.json())

<?php
$ch = curl_init('https://apibox.io.vn/v1/vn-pii-redact');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => '{"text":"Khách hàng Nguyễn Văn An, CCCD 079203001234, SĐT 0909 123 456, email an.nguyen@gmail.com, STK VCB 0071000123456.","mode":"mask"}',
]);
$response = curl_exec($ch);
print_r(json_decode($response, true));

Response

{
  "redacted": "Khách hàng N. V. A., CCCD *********234, SĐT 090* *** 456, email a********@gmail.com, STK VCB *********3456.",
  "mode": "mask",
  "count": 5,
  "by_type": {
    "person": 1,
    "cccd": 1,
    "phone": 1,
    "email": 1,
    "bank_account": 1
  },
  "contains_sensitive": true,
  "entities": [
    {
      "type": "person",
      "text": "Nguyễn Văn An",
      "start": 11,
      "end": 24,
      "confidence": 0.9,
      "sensitive": false,
      "reason": "name after a title or \"tên\"",
      "replacement": "N. V. A."
    },
    {
      "type": "cccd",
      "text": "079203001234",
      "start": 31,
      "end": 43,
      "confidence": 0.98,
      "sensitive": false,
      "reason": "CCCD number (valid province and century codes)",
      "replacement": "*********234"
    },
    {
      "type": "phone",
      "text": "0909 123 456",
      "start": 49,
      "end": 61,
      "confidence": 0.95,
      "sensitive": false,
      "reason": "mobile number (MobiFone)",
      "replacement": "090* *** 456"
    },
    "…"
  ],
  "legal_basis": "Luật Bảo vệ dữ liệu cá nhân 91/2025/QH15 (hiệu lực 01/01/2026), NĐ 356/2025/NĐ-CP",
  "reviewed": "2026-11-11",
  "disclaimer": "Detection aid based on patterns, checksums and context words: names and addresses can be missed or over-matched. It does not by itself make processing compliant."
}

Use cases

• Mask customer data in support tickets before sharing them
• Strip personal data from chats before sending them to an LLM
• Pseudonymise exports for analytics or a third party
• Audit documents for CCCD, accounts and cards

FAQ

Related APIs