verify-document

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

Tags: KYC

Summary

Verify document

Description

Verify document number before saving.

TypeScript Definition

"verify-document": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description customer id */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    document_number: string;
                    document_type_id: string;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            document?: components["schemas"]["GstinDetail"] | components["schemas"]["PanDetail"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            /** @description Unauthorized */
            401: {
                headers: {
                    [name: string]: unknown;
                };
                content?: never;
            };
            /** @description Not Found */
            404: {
                headers: {
                    [name: string]: unknown;
                };
                content?: never;
            };
        };
    };

Component References

Reference	Resolves To
components["schemas"]["GstinDetail"]	GstinDetail
components["schemas"]["PanDetail"]	PanDetail
components["responses"]["BadRequest"]	BadRequest

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

401

Unauthorized

404

Not Found

OpenAPI Definition

{
  "tags": [
    "KYC"
  ],
  "operationId": "verify-document",
  "summary": "Verify document",
  "description": "Verify document number before saving.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/verify-document",
    "description": "API reference for the verify-document operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "document_number",
            "document_type_id"
          ],
          "properties": {
            "document_number": {
              "type": "string"
            },
            "document_type_id": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "document": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/GstinDetail"
                      },
                      {
                        "$ref": "#/components/schemas/PanDetail"
                      }
                    ]
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "description": "Unauthorized"
    },
    "404": {
      "description": "Not Found"
    }
  },
  "x-speakeasy-group": "kyc",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "verifyDocument"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions