Siswati PII Detection API

Detect Personal Data in Siswati

Identify and protect personally identifiable information in Siswati text with our specialized API

PII Detection Demo

POST https://api.siswati-dlp.com/v1/detect-pii

Request

{
  "text": "Ligama lami nguSipho Dlamini. 
  Linombolo yami yekhasisi i-1234-5678-9012-3456. 
  Sihlala eMbabane, linombolo yami yemucu i-123456789.",
  "language": "ss",
  "options": {
    "returnRiskScores": true,
    "highlightMatches": true
  }
}
                                

Response

{
  "piiFindings": [
    {
      "type": "PERSON_NAME",
      "score": 0.98,
      "risk": "HIGH",
      "match": "Sipho Dlamini",
      "context": "Ligama lami nguSipho Dlamini"
    },
    {
      "type": "CREDIT_CARD_NUMBER",
      "score": 0.95,
      "risk": "HIGH",
      "match": "1234-5678-9012-3456",
      "context": "Linombolo yami yekhasisi i-1234-5678-9012-3456"
    },
    {
      "type": "NATIONAL_ID",
      "score": 0.92,
      "risk": "HIGH",
      "match": "123456789",
      "context": "linombolo yami yemucu i-123456789"
    },
    {
      "type": "LOCATION",
      "score": 0.85,
      "risk": "MEDIUM",
      "match": "Mbabane",
      "context": "Sihlala eMbabane"
    }
  ],
  "processedText": "Ligama lami nguSipho Dlamini. 
  Linombolo yami yekhasisi i-1234-5678-9012-3456. 
  Sihlala eMbabane, linombolo yami yemucu i-123456789.",
  "stats": {
    "totalPiiFound": 4,
    "highRiskCount": 3,
    "mediumRiskCount": 1,
    "lowRiskCount": 0
  }
}

Supported PII Types

PII Type Risk Level Detection Method Examples
Full Name HIGH Pattern matching for common Siswati name structures Sipho Dlamini, Nomvula Nkosi
National ID HIGH Eswatini ID number patterns and checksums 123456789, 987-654-321
Bank Account HIGH Bank-specific account number patterns 1234567890, 9876543210
Phone Number MEDIUM Eswatini phone number formats +268 76 123 4567, 761234567
Email Address MEDIUM Standard email patterns with common domains sipho@example.co.sz
Location MEDIUM Eswatini place names database Mbabane, Manzini, Lobamba

API Reference

Endpoint: Detect PII

POST /v1/detect-pii

Request Parameters

{
  "text": "string",          // Required: Text to analyze
  "language": "ss",         // Required: Language code for Siswati
  "options": {
    "returnRiskScores": boolean,  // Whether to include risk scores
    "highlightMatches": boolean,  // Whether to highlight matches
    "strictMode": boolean        // Use stricter matching rules
  }
}
                        

Response Fields

{
  "piiFindings": [          // Array of detected PII
    {
      "type": "string",    // PII type (e.g., "PERSON_NAME")
      "score": number,     // Confidence score (0-1)
      "risk": "string",    // Risk level (HIGH/MEDIUM/LOW)
      "match": "string",   // The matched text
      "context": "string"  // Surrounding text for context
    }
  ],
  "processedText": "string", // Text with PII highlighted
  "stats": {               // Summary statistics
    "totalPiiFound": number,
    "highRiskCount": number,
    "mediumRiskCount": number,
    "lowRiskCount": number
  }
}
                        

Error Responses

{
  "error": {
    "code": "string",      // Error code (e.g., "INVALID_TEXT")
    "message": "string",   // Human-readable message
    "details": "string"   // Additional details if available
  }
}
                        

Made with DeepSite LogoDeepSite - 🧬 Remix