Document

Type: schema

TypeScript Definition

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