LegalAcknowledgmentDisclosures

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karmacheck/json-schema/karmacheck-legal-acknowledgment-disclosures-schema.json",
  "title": "LegalAcknowledgmentDisclosures",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karmacheck-candidate-onboarding-api-openapi.yml#/components/schemas/LegalAcknowledgmentDisclosures",
  "type": "object",
  "required": [
    "sendReport",
    "list"
  ],
  "properties": {
    "sendReport": {
      "type": "boolean",
      "description": "If true, a report notification will be emailed to the candidate when the report is finished."
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "legalType"
        ],
        "properties": {
          "legalType": {
            "$ref": "#/$defs/LegalType",
            "description": "The type of legal disclosure. This is the value returned after calling [Request location-specific disclosures](karma-api-openapi.yaml/paths/~1case~1id~1{caseId}~1{disclosureType}~1{language}/post)."
          },
          "signature": {
            "type": "string",
            "description": "The value that the candidate entered into the signature input field on the legal step. Required if `legalType` is `general-*` or `custom-*`; not required for other types of legal disclosures."
          }
        }
      }
    }
  },
  "$defs": {
    "LegalType": {
      "title": "LegalType",
      "type": "string",
      "enum": [
        "general-all-disclosure",
        "general-ca-disclosure",
        "state-city-all-disclosure",
        "custom-ab-disclosure-1",
        "custom-ab-ca-disclosure-1",
        "custom-ab-disclosure-2",
        "custom-ab-ca-disclosure-2",
        "custom-dynamic-all-disclosure",
        "custom-dynamic-ca-disclosure"
      ],
      "description": "The type of legal disclosure."
    }
  }
}