Skip to content

GenerateOtpWithPhone

Type: schema

TypeScript Definition

typescript
GenerateOtpWithPhone: {{
            /** @enum {unknown} */
            channel: "sms" | "whatsapp";
            /** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
            country_code?: string | null;
            /** @description 10 digit phone number without country code. */
            phone: string;
            /** @enum {string} */
            otp_action: "register" | "reset-password" | "verify-phone" | "update-phone";
        };
        /** GstinDetail */
}

OpenAPI Schema

json
{
  "title": "GenerateOtpWithPhone",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/GenerateOtpWithPhone",
    "description": "API reference for the GenerateOtpWithPhone schema"
  },
  "required": [
    "channel",
    "phone",
    "otp_action"
  ],
  "properties": {
    "channel": {
      "enum": [
        "sms",
        "whatsapp"
      ]
    },
    "country_code": {
      "description": "Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.",
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "10 digit phone number without country code.",
      "type": "string"
    },
    "otp_action": {
      "type": "string",
      "enum": [
        "register",
        "reset-password",
        "verify-phone",
        "update-phone"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: