Close Mini App

Programmatically close the mini app using the unified MiniKit API.

Use MiniKit.closeMiniApp() to programmatically close the mini app.

Availability

• Works natively in World App
• Supports a custom fallback outside World App

Basic Usage

import { MiniKit } from "@worldcoin/minikit-js";
import type {
  CommandResultByVia,
  CloseMiniAppResult,
  MiniKitCloseMiniAppOptions,
} from "@worldcoin/minikit-js/commands";

export async function closeMiniApp() {
  const input = {} satisfies MiniKitCloseMiniAppOptions;

  const result: CommandResultByVia<
    CloseMiniAppResult,
    CloseMiniAppResult,
    "minikit"
  > = await MiniKit.closeMiniApp(input);

  return result.data.status;
}

Result

Type

type CloseMiniAppResponse =
  | {
      executedWith: "minikit";
      data: {
        status: "success";
        version: number;
      };
    }
  | {
      executedWith: "fallback";
      data: unknown;
    };

Fallback Behavior

Use a custom fallback if you want equivalent behavior outside World App.