-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix: verification_level, World ID Device, OIDC claim * feat: idkit v1.1, update incognito actions section of try it page * feat: verification levels page merged "World ID Device" and "Proof of Personhood" pages to create this * fix: remove theme param and add to migration guide * feat: user-agent header requirement * fix: try page theme * fix: closing tag * feat: verify with world id page * feat: errors reorg * fix: feedback
- Loading branch information
Showing
18 changed files
with
348 additions
and
979 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import { Tag } from '@/components/Tag' | ||
| import { Link } from '@/components/Link' | ||
|
|
||
| # Verification Levels | ||
|
|
||
| The World ID Protocol supports multiple levels of verification, each with a different level of assurance that the user is a unique human. | ||
|
|
||
| ## Available Verification Levels | ||
|
|
||
| This list will continue to grow as more verification levels are supported for proof of personhood in the World ID Protocol. | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Verification Level</th> | ||
| <th>Description</th> | ||
| <th>Humanness Level</th> | ||
| <th>Availability</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td className="flex items-center"><img src="/icons/credential-phone.svg" alt="" className="h-8 w-8 m-0 mr-2" />Device</td> | ||
| <td className="align-middle">Unique device check.</td> | ||
| <td className="align-middle">Medium</td> | ||
| <td className="align-middle"><Tag color="sky">CLOUD</Tag></td> | ||
| </tr> | ||
| <tr> | ||
| <td className="align-middle"><img src="/icons/credential-orb.svg" alt="" className="h-8 w-8 m-0 mr-2 inline" />Orb</td> | ||
| <td className="align-middle">Biometric verification, uniqueness through iris (<Link href="https://worldcoin.org/blog/engineering/opening-orb-look-inside-worldcoin-biometric-imaging-device">details</Link>).</td> | ||
| <td className="align-middle">Strong</td> | ||
| <td className="align-middle"><Tag>ON-CHAIN</Tag><Tag color="sky">CLOUD</Tag></td> | ||
| </tr> | ||
| <tr> | ||
| <td className="flex items-center"><img src="/icons/credential-face.svg" alt="" className="h-8 w-8 m-0 mr-2" />Orb+</td> | ||
| <td className="align-middle">Verify that the same person who visited the Orb is performing a specific action.</td> | ||
| <td className="align-middle">Very Strong</td> | ||
| <td className="align-middle"><Tag color="zinc">COMING SOON</Tag></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| ### World ID Orb | ||
|
|
||
| World ID Orb is the strongest verification level currently available in World ID. It's a biometric verification that relies on the user visiting a World ID Orb, which verifies that the user is a unique human while preserving their privacy. | ||
|
|
||
| ### World ID Device | ||
|
|
||
| World ID Device relies on the user's identity wallet, such as World App, to verify a user's unique device. This is more scalable, user friendly, and privacy-preserving than the previous `phone` credential, which was issued when a user verified their phone number in World App. | ||
|
|
||
| ## When to use World ID Device vs. Orb | ||
|
|
||
| World ID Device offers an assurance that's convenient for a user to obtain, but it also provides a weaker level of resistance to Sybil attacks than World ID's Orb credential. It's best used for applications that only require a moderate level of sybil resistance or have a significant user base in regions where the Orb is not available. | ||
|
|
||
| We recommend requiring World ID Orb in instances where users are given a financial incentive, such as a signup bonus or airdrop. For other situations, such as a social media app, it may be sufficient to only require World ID Device. An application can always react according to the verification level used, e.g. when an Orb-verified user performs an action that requires World ID Device. | ||
|
|
||
| <Note>Read about configuring IDKit for World ID Device in the [IDKit Reference](/reference/idkit/).</Note> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Verify with World ID | ||
|
|
||
| "Verify with World ID" is the recommended flow for your World ID integration, providing the most flexibility and the least amount of friction for your users. | ||
|
|
||
| Users should first create an account with your service, and then verify that account with World ID. This allows for existing users to seamlessly upgrade their account by verifying, and for new users to create an account and verify all at once. | ||
|
|
||
| ## Integration | ||
|
|
||
| "Verify with World ID" can be implemented either with [Sign In with World ID](/id/sign-in) or [Incognito Actions](/id/incognito-actions). The user flow is the same for both, but the implementation is slightly different. | ||
|
|
||
| ### When to use Sign In with World ID | ||
| You should use **Sign In with World ID** if you already allow users to sign in with other identity providers and link multiple accounts together. For example, if a user can sign in to a single account with either an email and password or a Google account, you should use Sign In with World ID. | ||
| The user should be able to add Sign In with World ID as a new login method to their existing account, or first create an account with Sign In with World ID and then link other sign in methods to that same account. | ||
|
|
||
| <Note>Applications using Auth0 for managing sign in can easily add Sign In with World ID as a new login method. See [Auth0's documentation on User Account Linking](https://auth0.com/docs/manage-users/user-accounts/user-account-linking) and our [Auth0 Integration](https://worldcoin.org/auth0) for more details.</Note> | ||
|
|
||
| ### When to use Incognito Actions | ||
| You should use **Incognito Actions** if you do not want to allow users to sign in using their World ID. In this case, you should use Incognito Actions to verify the user's existing account from a setting menu or prompt them for verification when they first sign in. | ||
|
|
||
| <Note>Incognito Actions are very flexible and can be used to verify for multiple one-time actions. Read our [Incognito Actions documentation](/id/incognito-actions) for more details.</Note> |
Oops, something went wrong.