Document

Type: schema

TypeScript Definition

Document: {{
            readonly id?: string;
            document_number: string;
            kyc_document_id: string;
            note?: string;
            /**
             * Format: binary
             * @description file attachment will be required or optional as per store setting.
             */
            file?: string;
            /** @enum {unknown} */
            readonly status?: "submitted" | "approved" | "rejected" | "expired";
            readonly title?: string;
            readonly file_url?: string;
            /** @enum {unknown} */
            readonly verification_type?: "automatic" | "manual";
            readonly is_verified?: boolean;
            /** Format: date-time */
            readonly verified_at?: string;
            /** @enum {unknown} */
            readonly created_by?: "customer" | "admin";
            /** Format: date-time */
            readonly created_at?: string;
            /** @enum {unknown} */
            readonly modified_by?: "customer" | "admin";
            /** Format: date-time */
            readonly modified_at?: string;
            readonly modified_reason?: string;
            /** Format: date-time */
            readonly expires_at?: string;
        };
        /** FixedAmountDiscountRule */
}

OpenAPI Schema

{
  "title": "Document",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Document",
    "description": "API reference for the Document schema"
  },
  "required": [
    "document_number",
    "kyc_document_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "document_number": {
      "type": "string"
    },
    "kyc_document_id": {
      "type": "string",
      "writeOnly": true
    },
    "note": {
      "type": "string"
    },
    "file": {
      "description": "file attachment will be required or optional as per store setting.",
      "type": "string",
      "format": "binary",
      "writeOnly": true
    },
    "status": {
      "enum": [
        "submitted",
        "approved",
        "rejected",
        "expired"
      ],
      "readOnly": true
    },
    "title": {
      "type": "string",
      "readOnly": true
    },
    "file_url": {
      "type": "string",
      "readOnly": true
    },
    "verification_type": {
      "enum": [
        "automatic",
        "manual"
      ],
      "readOnly": true
    },
    "is_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "verified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "enum": [
        "customer",
        "admin"
      ],
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_by": {
      "enum": [
        "customer",
        "admin"
      ],
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_reason": {
      "type": "string",
      "readOnly": true
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "KYC"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions