Appearance

check-verification-status ​

Method: POST
Path: /auth/verified-email-phone

Tags: Auth

Summary ​

Check email/phone verification status

Description ​

The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.

Storefront SDK Usage ​

SDK Method: sdk.auth.checkEmailOrPhoneIsVerified()

Example:

typescript
// Check verification status for multiple contacts
const { data, error } = await sdk.auth.checkEmailOrPhoneIsVerified({
  phone: ["9876543210", "9123456789"],
  email: ["user1@example.com", "user2@example.com"]
});

if (error) {
  console.error("Verification check failed:", error.message);
} else {
  console.log("Verified phones:", data.verified_phone);
  console.log("Verified emails:", data.verified_email);
}

TypeScript Definition ​

typescript
"check-verification-status": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** @description A string representing the phone number. */
                    phone?: string[];
                    /** @description A string representing the email address. */
                    email?: string[];
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @description A descriptive message confirming the success or failure of the operation. */
                        message: string;
                        /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
                        success: boolean;
                        /** @description An object containing the response content. */
                        content: {
                            /** @description An array containing verified phone numbers for the user */
                            verified_phone: string[];
                            /** @description An array containing verified email address for the user. */
                            verified_email: string[];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References ​

ReferenceResolves To
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized
components["responses"]["NotFound"]NotFound

Request Body ​

Content Types: application/json

Responses ​

200 ​

OK

400 ​

Bad request

401 ​

Not authorized for given operation on the Resource

404 ​

Requested resource not found

OpenAPI Definition ​

json
{
  "tags": [
    "Auth"
  ],
  "operationId": "check-verification-status",
  "summary": "Check email/phone verification status",
  "description": "The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/check-verification-status",
    "description": "API reference for the check-verification-status operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "phone": {
              "description": "A string representing the phone number.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "email": {
              "description": "A string representing the email address.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "description": "A descriptive message confirming the success or failure of the operation.",
                "type": "string"
              },
              "success": {
                "description": "Indicates whether the request was successful or failure (true for success, false for failure).",
                "type": "boolean"
              },
              "content": {
                "description": "An object containing the response content.",
                "properties": {
                  "verified_phone": {
                    "description": "An array containing verified phone numbers for the user",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "verified_email": {
                    "description": "An array containing verified email address for the user.",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "verified_phone",
                  "verified_email"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "auth",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "checkVerificationStatus"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: