Skip to content

KycDocumentConfig

Type: schema

TypeScript Definition

typescript
KycDocumentConfig: {{
            readonly id: string;
            /** @enum {unknown} */
            document_type: "gst" | "pan" | "other";
            title: string;
            description: string | null;
            /** @default true */
            active: boolean;
            is_mandatory: boolean;
            is_attachment_required: boolean;
            /** @enum {unknown} */
            verification_type: "auto" | "manual";
        };
        /** LotBatchDetail */
}

OpenAPI Schema

json
{
  "title": "KycDocumentConfig",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/KycDocumentConfig",
    "description": "API reference for the KycDocumentConfig schema"
  },
  "required": [
    "id",
    "document_type",
    "title",
    "description",
    "active",
    "is_mandatory",
    "is_attachment_required",
    "verification_type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "document_type": {
      "enum": [
        "gst",
        "pan",
        "other"
      ]
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "active": {
      "type": "boolean",
      "default": true
    },
    "is_mandatory": {
      "type": "boolean"
    },
    "is_attachment_required": {
      "type": "boolean"
    },
    "verification_type": {
      "enum": [
        "auto",
        "manual"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: