DlpAdvancedDocumentDetectionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-dlp-advanced-document-detection-request-schema.json",
  "title": "DlpAdvancedDocumentDetectionRequest",
  "description": "Request object for advanced DLP document detection with 29 PII detection types including health-related data.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-detect-api-openapi.yml#/components/schemas/DlpAdvancedDocumentDetectionRequest",
  "type": "object",
  "properties": {
    "InputFile": {
      "format": "byte",
      "description": "Document file bytes (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, or WEBP) to scan for PII and sensitive data.",
      "type": "string"
    },
    "FileName": {
      "description": "Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents.",
      "type": "string"
    },
    "RecognitionMode": {
      "description": "Optional. Recognition mode for image processing. Options: null (default), \"Normal\", \"Advanced\", \"Fast\", \"FastPlus\", \"FastMini\".",
      "type": "string"
    },
    "AllowEmailAddress": {
      "description": "Set to true to allow email addresses in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowPhoneNumber": {
      "description": "Set to true to allow phone numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowStreetAddress": {
      "description": "Set to true to allow street addresses in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowCity": {
      "description": "Set to true to allow standalone city names (e.g. \"San Francisco\") in the document and not flag them as PII. Applies to city names mentioned outside of a full street address.",
      "type": "boolean"
    },
    "AllowPersonName": {
      "description": "Set to true to allow person names in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowBirthDate": {
      "description": "Set to true to allow birth dates in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowPassportNumber": {
      "description": "Set to true to allow passport numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowDriversLicense": {
      "description": "Set to true to allow drivers license numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowSocialSecurityNumber": {
      "description": "Set to true to allow social security numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowTaxpayerID": {
      "description": "Set to true to allow taxpayer IDs in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowCreditCardNumber": {
      "description": "Set to true to allow credit card numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowCreditCardExpirationDate": {
      "description": "Set to true to allow credit card expiration dates in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowCreditCardVerificationCode": {
      "description": "Set to true to allow credit card verification codes in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowBankAccountNumber": {
      "description": "Set to true to allow bank account numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowIBAN": {
      "description": "Set to true to allow IBANs in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowHealthInsuranceNumber": {
      "description": "Set to true to allow health insurance numbers in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowBearerToken": {
      "description": "Set to true to allow bearer tokens in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowHttpCookie": {
      "description": "Set to true to allow HTTP cookies in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowPrivateKeys": {
      "description": "Set to true to allow private keys in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowCredentials": {
      "description": "Set to true to allow credentials (usernames/passwords) in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowDeepWebUrls": {
      "description": "Set to true to allow deep web URLs (.onion) in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowSourceCode": {
      "description": "Set to true to allow source code in the document and not flag it as sensitive data.",
      "type": "boolean"
    },
    "AllowIpAddress": {
      "description": "Set to true to allow IP addresses in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowMacAddress": {
      "description": "Set to true to allow MAC addresses in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowHealthInsuranceMemberID": {
      "description": "Set to true to allow health insurance member IDs in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowMedicalRecordNumber": {
      "description": "Set to true to allow medical record numbers in the document and not flag them as PHI.",
      "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 document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowHealthInjuryOrDisease": {
      "description": "Set to true to allow references to injuries or diseases in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowHealthTypeOfTreatment": {
      "description": "Set to true to allow references to types of medical treatment in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowHealthDateAndTimeOfTreatment": {
      "description": "Set to true to allow dates and times of medical treatment in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowHealthPlanBeneficiaryNumber": {
      "description": "Set to true to allow health plan beneficiary numbers in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowHealthPaymentsMadeForTreatment": {
      "description": "Set to true to allow payments made for medical treatment in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowFaces": {
      "description": "Set to true to allow identifiable human faces in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowVehicleID": {
      "description": "Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowDeviceID": {
      "description": "Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowNamesOfRelatives": {
      "description": "Set to true to allow names of relatives in the document and not flag them as PII.",
      "type": "boolean"
    },
    "AllowHealthUniversalRecordLocator": {
      "description": "Set to true to allow health universal record locators (URLs) in the document and not flag them as PHI.",
      "type": "boolean"
    },
    "AllowBiometrics": {
      "description": "Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the document and not flag them as PII.",
      "type": "boolean"
    },
    "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"
    }
  },
  "additionalProperties": false
}