DocumentCreateRecords

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karmacheck/json-schema/karmacheck-document-create-records-schema.json",
  "title": "DocumentCreateRecords",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karmacheck-secure-documents-api-openapi.yml#/components/schemas/DocumentCreateRecords",
  "type": "object",
  "required": [
    "list"
  ],
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "originalFileName",
          "documentTypeId",
          "fileKey"
        ],
        "properties": {
          "originalFileName": {
            "type": "string",
            "description": "The file name for the document that was uploaded."
          },
          "documentTypeId": {
            "type": "string",
            "description": "The type of document to store.\n\nAllowed value: `candidate-disclosures-and-authorizations`"
          },
          "fileKey": {
            "type": "string",
            "description": "The value from the [Generate secure document upload URLs](karma-api-openapi.yaml/paths/~1document~1secure~1upload/post) response."
          },
          "title": {
            "type": "string",
            "description": "A title for the document."
          },
          "description": {
            "type": "string",
            "description": "A description of the document."
          },
          "fileFormat": {
            "description": "The file format (e.g. pdf, jpeg, png)",
            "type": "string",
            "enum": [
              "pdf",
              "jpg",
              "jpeg",
              "png"
            ]
          }
        }
      }
    },
    "accessGrants": {
      "type": "object",
      "required": [
        "caseId"
      ],
      "properties": {
        "caseId": {
          "type": "string",
          "description": "The ID of the case to associate with the document."
        }
      }
    }
  }
}