Document
Type: schema
TypeScript Definition
typescript
Document: {{
id?: $Read<string>;
document_number: string;
kyc_document_id: $Write<string>;
/** @description Document type slug from store KYC configuration. Populated for marketplace stores; `null` or omitted otherwise. */
document_type_slug?: $Read<string | null>;
/** @description ID of the store KYC document-type configuration this document belongs to (resolved from the write-only `kyc_document_id`). */
document_type_id?: $Read<string>;
/** @description ULID of the user who created the document. */
created_by_user_id?: $Read<string>;
/** @description ULID of the user who last modified the document. */
modified_by_user_id?: $Read<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>;
created_by?: $Read<string | null>;
/** Format: date-time */
created_at?: $Read<string>;
modified_by?: $Read<string | null>;
/** Format: date-time */
modified_at?: $Read<string>;
modified_reason?: $Read<string>;
/** Format: date-time */
expires_at?: $Read<string>;
} & {
[key: string]: unknown;
};
/** FixedAmountDiscountRule */
}OpenAPI Schema
json
{
"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
},
"document_type_slug": {
"description": "Document type slug from store KYC configuration. Populated for marketplace stores; `null` or omitted otherwise.",
"type": [
"string",
"null"
],
"readOnly": true
},
"document_type_id": {
"description": "ID of the store KYC document-type configuration this document belongs to (resolved from the write-only `kyc_document_id`).",
"type": "string",
"readOnly": true
},
"created_by_user_id": {
"description": "ULID of the user who created the document.",
"type": "string",
"readOnly": true
},
"modified_by_user_id": {
"description": "ULID of the user who last modified the document.",
"type": "string",
"readOnly": 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": {
"type": [
"string",
"null"
],
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_by": {
"type": [
"string",
"null"
],
"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
}
},
"additionalProperties": true,
"x-tags": [
"KYC"
]
}Auto-generated from OpenAPI spec and TypeScript definitions