list-documents

Method: GET
Path: /customers/{id}/documents

Tags: KYC

Summary

List all documents

Description

List all documents added by a particular customer.

TypeScript Definition

"list-documents": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description customer id */
                id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            documents?: components["schemas"]["Document"][];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["Document"]	Document
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "KYC"
  ],
  "operationId": "list-documents",
  "summary": "List all documents",
  "description": "List all documents added by a particular customer.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-documents",
    "description": "API reference for the list-documents operation"
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "documents": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Document"
                    }
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "x-speakeasy-group": "kyc",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listDocuments"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions