Get Permissions

Read current mini app permission settings using the unified MiniKit API.

Use MiniKit.getPermissions() to read the current permission state for the mini app.

Basic Usage

Example

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

export async function getPermissions() {
  const input = {} satisfies MiniKitGetPermissionsOptions;

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

  console.log(result.data.permissions);
}

Result

Type

type GetPermissionsResponse =
  | {
      executedWith: "minikit";
      data: {
        status: "success";
        version: number;
        permissions: {
          notifications?: any;
          contacts?: any;
          microphone?: any;
        };
        timestamp: string;
      };
    }
  | {
      executedWith: "fallback";
      data: unknown;
    };

Fallback Behavior

Define a custom fallback in the command payload for support outside mini apps.

Error Codes

Code	Meaning
generic_error	Unexpected failure