Quick Start

Commands

Commands are defined payloads that the mini app can send to the World App.

These are the current commands available in MiniKit:

Command	Description
Verify	Verify an action with World ID.
Pay	Initiate a payment request.
Wallet Auth	Authenticate via Sign in with Ethereum
Send Transaction	Write to smart contracts
Sign Message	Sign personal messages with your wallet
Sign Typed Data	Sign EIP-712 payloads with your wallet
Share Social Graph (coming soon)	Allows users to share their contacts in a privacy preserving way with apps
Notifications (coming soon)	Send notifications to users

Example

Below is an example of how to use the Verify command in your mini app.

import { MiniKit, VerificationLevel, VerifyCommandInput } from '@worldcoin/minikit-js'

const verifyPayload: VerifyCommandInput = {
	action: 'voting-action',
	verification_level: VerificationLevel.Orb,
	signal: '0x12312', // Optional
}

const payload = MiniKit.commands.verify(verifyPayload)