IDKit is the toolkit for identity online. With IDKit you can easily interact with the World ID Protocol.

Integration is very straightforward. Follow the relevant steps below.

yarn add @worldcoin/idkit
# or
npm i @worldcoin/idkit
# or
pnpm install @worldcoin/idkit

import { IDKitWidget } from "@worldcoin/idkit";

<IDKitWidget actionId="get_this_from_the_dev_portal" signal="my_signal" handleVerify={verifyProof}>
  {({ open }) => (
    {/* You can render whatever you want here, and call open() to open the widget */}
    <button onClick={open}>Verify with World ID</button>
  )}
</IDKitWidget>

yarn add @worldcoin/idkit-react-native
# or
npm i @worldcoin/idkit-react-native
# or
pnpm install @worldcoin/idkit-react-native

React Native requires polyfills for crypto functionality:

// polyfills.ts
import { install } from 'react-native-quick-crypto'

install()

Basic usage:

import { Session, VerificationState } from '@worldcoin/idkit-react-native'

// Create a new verification session
const session = await new Session().create('app_id', 'your-action')

// Get the connector URI that redirects user to the World App
// Optional: Add a `return_to` query param that deeplinks back to the app
const connectorUrl = new URL(session.sessionURI)
connectorUrl.searchParams.set('return_to', returnTo)
const connectUrlWithReturnAddress = connectorUrl.toString()

// Poll for updates to check verification status
const checkStatus = async () => {
	const status = await session.status()

	if (status.state === VerificationState.Confirmed) {
		console.log('Verification successful:', status.result)
	} else if (status.state === VerificationState.Failed) {
		console.log('Verification failed:', status.errorCode)
	}
}

// Clean up when done
const cleanup = () => {
	session.destroy()
}

More details can be found in the documentation.

IDKit exposes the handleVerify option for your app to perform additional verification on the returned response, often a call to an API that ensures the proof is valid.

Warning Make sure you verify the proof, and that you don't do it client-side!

Optionally, IDKit also provides an onSuccess option, which you can use if your app needs to execute some code after verification succeeds.

World ID is the privacy-first identity protocol that brings global proof of personhood to the internet. More on World ID in the announcement blog post.

World ID lets you seamlessly integrate authentication into your app that verifies accounts belong to real persons through Sign in with Worldcoin. For additional flexibility and cases where you need extreme privacy, Anonymous Actions lets you verify users in a way that cannot be tracked across verifications.

Follow the Quick Start guide for the easiest way to get started.

All the technical docs for the World ID SDK, World ID Protocol, examples, guides can be found at https://docs.world.org/

To develop locally, run the following in your terminal:

pnpm i && pnpm dev

This will install all necessary dependencies and start two local development servers -- one using examples/with-html and one using examples/with-next. Check your console for the URLS for each, and open them in your browser. Any changes made to packages/core, packages/react or packages/standalone will be automatically built and the examples will be reloaded.

To bump the version of the package, run:

pnpm changeset