list-kyc-document

Method: GET
Path: /store/kyc-document

Tags: Store

Summary

List KYC documents

Description

Retrieves the list of KYC document types required for the store. Returns an array of Kyc Document objects defining document types, mandatory flags, and verification settings.

TypeScript Definition

"list-kyc-document": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            kyc_documents?: components["schemas"]["KycDocumentConfig"][];
                            /** @default false */
                            is_kyc_enabled: $Read<boolean>;
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["KycDocumentConfig"]	KycDocumentConfig
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Responses

200

OK

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Store"
  ],
  "operationId": "list-kyc-document",
  "summary": "List KYC documents",
  "description": "Retrieves the list of KYC document types required for the store. Returns an array of `Kyc Document` objects defining document types, mandatory flags, and verification settings.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-kyc-document",
    "description": "API reference for the list-kyc-document operation"
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "kyc_documents": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/KycDocumentConfig"
                    }
                  },
                  "is_kyc_enabled": {
                    "type": "boolean",
                    "default": false,
                    "readOnly": true
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "X-Api-Key": []
    }
  ],
  "x-speakeasy-group": "store",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listKycDocuments"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions