Vapi · Schema

CompliancePlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
hipaaEnabled boolean When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false. Only HIPAA-compliant providers will be available for LLM, Voice, and Transcribe
pciEnabled boolean When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored. At the end of the call, you will receive an end-of-call-report message to store
securityFilterPlan object This is the security filter plan for the assistant. It allows filtering of transcripts for security threats before sending to LLM.
recordingConsentPlan object
View JSON Schema on GitHub

JSON Schema

vapi-complianceplan-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompliancePlan",
  "title": "CompliancePlan",
  "type": "object",
  "properties": {
    "hipaaEnabled": {
      "type": "boolean",
      "description": "When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false. Only HIPAA-compliant providers will be available for LLM, Voice, and Transcriber respectively. This setting is only honored if the organization is on an Enterprise subscription or has purchased the HIPAA add-on."
    },
    "pciEnabled": {
      "type": "boolean",
      "description": "When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored.\nAt the end of the call, you will receive an end-of-call-report message to store on your server. Defaults to false.",
      "example": {
        "pciEnabled": false
      }
    },
    "securityFilterPlan": {
      "description": "This is the security filter plan for the assistant. It allows filtering of transcripts for security threats before sending to LLM.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SecurityFilterPlan"
        }
      ]
    },
    "recordingConsentPlan": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/RecordingConsentPlanStayOnLine",
          "title": "RecordingConsentStayOnLinePlan"
        },
        {
          "$ref": "#/components/schemas/RecordingConsentPlanVerbal",
          "title": "RecordingConsentPlanVerbal"
        }
      ],
      "discriminator": {
        "propertyName": "type",
        "mapping": {
          "stay-on-line": "#/components/schemas/RecordingConsentPlanStayOnLine",
          "verbal": "#/components/schemas/RecordingConsentPlanVerbal"
        }
      }
    }
  }
}