Skip to content

KycDocument ​

Type: schema

TypeScript Definition ​

typescript
KycDocument: {{
            id?: $Read<string>;
            document_number: string;
            note?: string | null;
            /**
             * Format: binary
             * @description file attachment will be required or optional as per store setting.
             */
            file?: $Write<string>;
            document_type_id: string;
            /** @description Document type slug from store KYC configuration. Populated for marketplace stores; `null` or omitted otherwise. */
            document_type_slug?: $Read<string | null>;
            /** @enum {unknown} */
            status?: $Read<"submitted" | "approved" | "rejected">;
            title?: $Read<string>;
            file_url?: $Read<string | null>;
            /** @enum {unknown} */
            verification_type?: $Read<"auto" | "manual">;
            is_verified?: $Read<boolean>;
            /** Format: date-time */
            verified_at?: $Read<string | null>;
            /** @description Actor that created the record. Typical values are `customer`, `admin`, or `import`; an empty string means unset on older records. */
            created_by?: $Read<string | null>;
            created_by_user_id?: $Read<string>;
            /** @description `YYYY-MM-DD HH:MM:SS` (UTC), not RFC 3339. */
            created_at?: $Read<string>;
            /** @description Actor that last modified the record. Typical values are `customer`, `admin`, or `import`; an empty string means unset on older records. */
            modified_by?: $Read<string | null>;
            modified_by_user_id?: $Read<string | null>;
            /** @description `YYYY-MM-DD HH:MM:SS` (UTC), not RFC 3339. */
            modified_at?: $Read<string>;
            modified_reason?: $Read<string | null>;
        } & {
            [key: string]: unknown;
        };
        /** KycDocumentConfig */
}

OpenAPI Schema ​

json
{
  "title": "KycDocument",
  "type": "object",
  "required": [
    "document_number",
    "document_type_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "document_number": {
      "type": "string"
    },
    "note": {
      "type": [
        "string",
        "null"
      ]
    },
    "file": {
      "description": "file attachment will be required or optional as per store setting.",
      "type": "string",
      "format": "binary",
      "writeOnly": true
    },
    "document_type_id": {
      "type": "string"
    },
    "document_type_slug": {
      "description": "Document type slug from store KYC configuration. Populated for marketplace stores; `null` or omitted otherwise.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "status": {
      "enum": [
        "submitted",
        "approved",
        "rejected"
      ],
      "readOnly": true
    },
    "title": {
      "type": "string",
      "readOnly": true
    },
    "file_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "verification_type": {
      "enum": [
        "auto",
        "manual"
      ],
      "readOnly": true
    },
    "is_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "verified_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "description": "Actor that created the record. Typical values are `customer`, `admin`, or `import`; an empty string means unset on older records.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "created_by_user_id": {
      "type": "string",
      "readOnly": true
    },
    "created_at": {
      "description": "`YYYY-MM-DD HH:MM:SS` (UTC), not RFC 3339.",
      "type": "string",
      "readOnly": true
    },
    "modified_by": {
      "description": "Actor that last modified the record. Typical values are `customer`, `admin`, or `import`; an empty string means unset on older records.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "modified_by_user_id": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "modified_at": {
      "description": "`YYYY-MM-DD HH:MM:SS` (UTC), not RFC 3339.",
      "type": "string",
      "readOnly": true
    },
    "modified_reason": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    }
  },
  "additionalProperties": true,
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: