KycDocument

Type: schema

TypeScript Definition

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

OpenAPI Schema

{
  "title": "KycDocument",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/KycDocument",
    "description": "API reference for the KycDocument schema"
  },
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "document_type": {
      "enum": [
        "gst",
        "pan",
        "tin",
        "cin",
        "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