DlpAdvancedRedactionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-dlp-advanced-redaction-request-schema.json",
  "title": "DlpAdvancedRedactionRequest",
  "description": "Request object for advanced DLP text redaction with 34 PII detection types including health-related data and configurable redaction mode.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-tasksbatchjob-api-openapi.yml#/components/schemas/DlpAdvancedRedactionRequest",
  "type": "object",
  "properties": {
    "InputText": {
      "description": "Text to scan for PII and redact sensitive data from.",
      "type": "string"
    },
    "AllowEmailAddress": {
      "description": "Set to true to allow email addresses in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowPhoneNumber": {
      "description": "Set to true to allow phone numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowStreetAddress": {
      "description": "Set to true to allow street addresses in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowCity": {
      "description": "Set to true to allow standalone city names (e.g. \"San Francisco\") in the input text and not redact them. Applies to city names mentioned outside of a full street address.",
      "type": "boolean"
    },
    "AllowPersonName": {
      "description": "Set to true to allow person names in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowBirthDate": {
      "description": "Set to true to allow birth dates in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowPassportNumber": {
      "description": "Set to true to allow passport numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowDriversLicense": {
      "description": "Set to true to allow drivers license numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowSocialSecurityNumber": {
      "description": "Set to true to allow social security numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowTaxpayerID": {
      "description": "Set to true to allow taxpayer IDs in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowCreditCardNumber": {
      "description": "Set to true to allow credit card numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowCreditCardExpirationDate": {
      "description": "Set to true to allow credit card expiration dates in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowCreditCardVerificationCode": {
      "description": "Set to true to allow credit card verification codes in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowBankAccountNumber": {
      "description": "Set to true to allow bank account numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowIBAN": {
      "description": "Set to true to allow IBANs in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthInsuranceNumber": {
      "description": "Set to true to allow health insurance numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowBearerToken": {
      "description": "Set to true to allow bearer tokens in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHttpCookie": {
      "description": "Set to true to allow HTTP cookies in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowPrivateKeys": {
      "description": "Set to true to allow private keys in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowCredentials": {
      "description": "Set to true to allow credentials (usernames/passwords) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowDeepWebUrls": {
      "description": "Set to true to allow deep web URLs (.onion) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowSourceCode": {
      "description": "Set to true to allow source code in the input text and not redact it.",
      "type": "boolean"
    },
    "AllowIpAddress": {
      "description": "Set to true to allow IP addresses in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowMacAddress": {
      "description": "Set to true to allow MAC addresses in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthInsuranceMemberID": {
      "description": "Set to true to allow health insurance member IDs in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowMedicalRecordNumber": {
      "description": "Set to true to allow medical record numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowBillingAccountNumber": {
      "description": "Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthInjuryOrDisease": {
      "description": "Set to true to allow references to injuries or diseases in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthTypeOfTreatment": {
      "description": "Set to true to allow references to types of medical treatment in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthDateAndTimeOfTreatment": {
      "description": "Set to true to allow dates and times of medical treatment in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthPlanBeneficiaryNumber": {
      "description": "Set to true to allow health plan beneficiary numbers in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthPaymentsMadeForTreatment": {
      "description": "Set to true to allow payments made for medical treatment in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowVehicleID": {
      "description": "Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowDeviceID": {
      "description": "Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowNamesOfRelatives": {
      "description": "Set to true to allow names of relatives in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowHealthUniversalRecordLocator": {
      "description": "Set to true to allow health universal record locators (URLs) in the input text and not redact them.",
      "type": "boolean"
    },
    "AllowBiometrics": {
      "description": "Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the input text and not redact them.",
      "type": "boolean"
    },
    "RedactionMode": {
      "description": "Redaction mode: \"SemanticTag\" (default) replaces PII with a semantic tag in square brackets (e.g. [PHONE-NUMBER]), \"Delete\" removes PII entirely, or \"ReplaceWithAsterisk\" replaces PII characters with asterisks (*).",
      "type": "string"
    },
    "ProvideAnalysisRationale": {
      "description": "Set to true to include a natural language rationale explaining why each detection conclusion was formed.",
      "type": "boolean"
    },
    "CustomPolicyID": {
      "description": "Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy,\nnavigate to the Cloudmersive Management Portal and select Custom Policies.\nRequires Managed Instance or Private Cloud",
      "type": "string"
    },
    "CustomFields": {
      "description": "Optional list of caller-defined custom PII fields to detect and redact in addition\nto the built-in categories. Each entry has a Title (used to derive the redaction\ntag, e.g. \"internal participant code\" → [INTERNAL-PARTICIPANT-CODE]) and a\nDescription telling the redaction LLM what the field looks like. Default null.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomPiiField"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "CustomPiiField": {
      "description": "Caller-defined custom PII field. The redaction LLM will look for content matching\nthe description and redact it as a semantic tag derived from the title\n(e.g. title \"internal participant code\" → tag [INTERNAL-PARTICIPANT-CODE]).",
      "type": "object",
      "properties": {
        "Title": {
          "description": "Short title for the custom field, also used to derive the semantic tag (uppercased, spaces/underscores replaced with hyphens).",
          "type": "string"
        },
        "Description": {
          "description": "Description of what this field looks like, used to instruct the redaction LLM. Be specific so the LLM can locate matches.",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  }
}