KycDocumentConfig
Type: schema
TypeScript Definition
typescript
KycDocumentConfig: {{
id?: $Read<string>;
/** @description Kind of KYC document the store collects. Known values are `gst`, `pan`, `drug_license` and `other`; the set is store-configurable and not exhaustive. */
document_type: string;
title: string;
description?: string | null;
/** @default true */
active: boolean;
is_mandatory: boolean;
is_attachment_required: boolean;
slug?: $Read<string>;
/** @enum {unknown} */
verification_type: "auto" | "manual";
/** @description When `true`, the document number must be unique across customers in the store. */
is_value_unique?: $Read<boolean>;
/** Format: date-time */
created_at?: $Read<string>;
/** Format: date-time */
modified_at?: $Read<string>;
};
/**
* @description KYC progress for a customer. `document_pending` means required documents have not been uploaded; `submitted` and `submitted_for_approval` mean they are awaiting review.
* @enum {unknown}
*/
}OpenAPI Schema
json
{
"title": "KycDocumentConfig",
"type": "object",
"required": [
"document_type",
"title",
"is_mandatory",
"is_attachment_required",
"verification_type"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"document_type": {
"description": "Kind of KYC document the store collects. Known values are `gst`, `pan`, `drug_license` and `other`; the set is store-configurable and not exhaustive.",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"active": {
"type": "boolean",
"default": true
},
"is_mandatory": {
"type": "boolean"
},
"is_attachment_required": {
"type": "boolean"
},
"slug": {
"type": "string",
"readOnly": true
},
"verification_type": {
"enum": [
"auto",
"manual"
]
},
"is_value_unique": {
"description": "When `true`, the document number must be unique across customers in the store.",
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions