create-document

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

Tags: KYC

Summary

Create document

Description

Create document

TypeScript Definition

"create-document": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description customer id */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "multipart/form-data": components["schemas"]["Document"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            document?: 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

Request Body

Content Types: multipart/form-data

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": "create-document",
  "summary": "Create document",
  "description": "Create document",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/create-document",
    "description": "API reference for the create-document operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "$ref": "#/components/schemas/Document"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "document": {
                    "$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": "createDocument"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions