Anonymous Actions
Get Started with IDKit
This guide assumes you have already completed the steps to set up the Developer Portal.
IDKit is required in your app's frontend for Anonymous Actions, both for Cloud and On-Chain use cases.
Creating Actions in the Dev Portal
Anonymous Actions can either be configured via the Developer Portal, or on-the-fly through IDKit. Creating actions on the Developer Portal is generally recommended, but setting on-the-fly is best for dynamic contexts. See the On-the-Fly Actions page for more information.
Create an action for your app in the Developer Portal. You must provide the following values:
- Action Name: The stringified action to be taken by the user.
- Description: This is shown to your user in the World app as they sign with their World ID, alongside your application logo. Make sure to fully describe the exact action the user is taking.
- Max Verifications: For Cloud actions only. The number of times a user can take this action. A value of
0indicates that unlimited verifications can take place.
An action scopes uniqueness for users, which means users will always generate the same ID (nullifier hash) when performing the same action. Cloud actions natively handle sybil-resistance with a limit set in the Developer Portal. For on-chain use cases, you can track this nullifier hash in your smart contract to implement sybil-resistance.
Installing IDKit
The JS package can be included in your project either as a module (which supports tree shaking to reduce bundle size) or you can add the script directly to your website.
Install IDKit
npm install @worldcoin/idkit
Usage
Import and render IDKit. You'll want to do this on the screen where the user executes the protected action (e.g. before they click "Claim airdrop" or "Vote on proposal").
import { IDKitWidget } from '@worldcoin/idkit'
<IDKitWidget
app_id="app_GBkZ1KlVUdFTjeMXKlVUdFT" // obtained from the Developer Portal
action="vote_1" // this is your action name from the Developer Portal
onSuccess={onSuccess} // callback when the modal is closed
handleVerify={handleVerify} // optional callback when the proof is received
credential_types={['orb', 'phone']} // optional, defaults to ['orb']
enableTelemetry // optional, defaults to false
>
{({ open }) => <button onClick={open}>Verify with World ID</button>}
</IDKitWidget>
More configuration options can be found in the IDKit reference.
When a user clicks the button, the IDKit modal will open and prompt them to scan a QR code and verify with World ID. Once this proof is received, the optional handleVerify callback is called immediately and the onSuccess callback will be called when the modal is closed.
One of these callbacks should begin the process of verifying the proof.