Entity Types Endpoint

Retrieve the list of all supported entity types at runtime.

Endpoint

GET /anonymize/entities

Try it live (desktop). The API Playground docked on the right is set to the Entity Types endpoint — just hit Send, no parameters needed.

Response

200 OK

{
  "entities": [
    {"name": "CUSTOM_ENTITY", "description": "User-defined custom entities for redaction"},
    {"name": "PERSON_NAME", "description": "People's names (first names, last names, full names)"},
    {"name": "NATIONAL_ID", "description": "National IDs: SSN, driver's license, ID card numbers"},
    {"name": "EMAIL_ADDRESS", "description": "Email addresses"},
    {"name": "PHONE_NUMBER", "description": "Phone numbers (landlines, mobile, international)"},
    {"name": "ADDRESS", "description": "Addresses, cities, countries, landmarks, streets"},
    {"name": "DATE", "description": "Dates and dates of birth"},
    {"name": "CREDIT_CARD", "description": "Credit card numbers (PAN)"},
    {"name": "IBAN", "description": "International bank account numbers"},
    {"name": "VAT_NUMBER", "description": "Tax registration identifiers (VAT, GST, EIN, ITIN)"},
    {"name": "USERNAME", "description": "User names and account identifiers"},
    {"name": "ORGANIZATION", "description": "Companies, agencies, institutions, organizations"},
    {"name": "ZIP_CODE", "description": "US ZIP codes (5 or 9 digit)"},
    {"name": "LICENSE_KEY", "description": "Software license keys"},
    {"name": "API_KEY", "description": "API keys for SaaS services, AI tools, etc."}
  ]
}

Examples

cURL

curl https://demo.questa-ai.online/anonymize/entities \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Usage

Use the entity name values in the entities parameter of anonymization requests:

{
  "text": "John's email is john@example.com.",
  "entities": "PERSON_NAME,EMAIL_ADDRESS"
}