| Verification Level | +Description | +Humanness Level | +Availability | +
|---|---|---|---|
 Device |
+ Unique device check. | +Medium | +|
 Orb |
+ Biometric verification, uniqueness through iris (details). | +Strong | +|
 Orb+ |
+ Verify that the same person who visited the Orb is performing a specific action. | +Very Strong | +
| Credential | -Sybil-Resistance | -Proof-of-Personhood | -Credential Acquisition | -Availability | -
|---|---|---|---|---|
| Orb |
- Strong | -Strong | -In-person Orb Verification | -|
| World ID Lite |
- Medium | -Weak | -Automatic Issuance | -
| Credential | -Description | -Humanness Level | -Availability | -
|---|---|---|---|
| Orb |
- Biometric in-person verification, uniqueness through iris (details). | -Strongest | -|
| World ID Lite |
- Unique device check. | -Weak | -|
| Face |
- Unique and privacy-preserving face match. | -Medium | -
| Code | +Source | Description | How to fix? |
|---|---|---|---|
| `failed_by_host_app` | +IDKit | An error was thrown in the `handleVerify` callback. | Assess the error thrown in your `handleVerify` callback and resolve the issue. @@ -24,6 +26,7 @@ These error codes are returned in the `onError` callback. |
| `connection_failed` | +IDKit | Could not establish a connection to World App. | Ask the user to check their internet connection on both devices running your application and World App. @@ -32,41 +35,55 @@ These error codes are returned in the `onError` callback. |
| `verification_rejected` | +Wallet Bridge | User rejected the World ID request in World App. | If this was a mistake, ask the user to go through the flow again. |
| `max_verifications_reached` | +Wallet Bridge | This person has already verified for this particular action the maximum number of times allowed. | Nothing to do. User cannot verify for this action again. |
| `credential_unavailable` | +Wallet Bridge | This user does not have the requested credential. | The user must verify at the Orb or verify their unique device in World App to receive the credential required. |
| `malformed_request` | +Wallet Bridge | The request payload couldn't be decrypted or did not conform to the standard. | Ensure IDKit is configured properly and all parameters are valid. See [above](#id-kit-react) for configuration details. |
| `invalid_network` | +Wallet Bridge | The application is configured for a different environment than the verifying user's client. | Ensure you use the [Worldcoin Simulator](https://simulator.worldcoin.org) for Staging applications and World App for Production applications. |
| `inclusion_proof_failed` | +Wallet Bridge | The sequencer returned an unexpected error when retrieving the inclusion proof. | Ask the user to try again. This may be due to a temporary network issue, or a bug with World App or the Signup Sequencer. |
| `inclusion_proof_pending` | +Wallet Bridge | The user might have the requested credential, but it is not available on-chain yet. It might be available for API verification. | Ask the user to verify again in approximately one hour. |
| `metadata_failed` | +Wallet Bridge | +Unable to load metadata for the app from the Developer Portal. | +Ensure your `app_id` is configured correctly in IDKit and exactly matches the `app_id` from the Developer Portal. | +
| `unexpected_response` | +IDKit | There was a problem with the response obtained from the WLD app. | Check the JS console for further details, though in most cases these will require contacting us to @@ -75,6 +92,7 @@ These error codes are returned in the `onError` callback. |
| `generic_error` | +Wallet Bridge or IDKit | An unhandled exception occurred. | Check the JS console for further details, though in most cases these will require contacting us to @@ -125,7 +143,7 @@ These error codes are returned in the `error` property of the response body. |
| `invalid_proof` | The provided proof is invalid and it cannot be verified. | -Ensure your `app_id`, `action`, `signal`, and `credential_type` are unchanged between the proof request and proof verification. | +Ensure your `app_id`, `action`, `signal`, and `verification_level` are unchanged between the proof request and proof verification. |
| `invalid_merkle_root` | @@ -179,68 +197,4 @@ These error codes are returned in the `error` property of the response body.
| Code | -Description | -How to fix? | -
|---|---|---|
| `verification_rejected` | -User rejected the World ID request in World App. | -If this was a mistake, ask the user to go through the flow again. | -
| `max_verifications_reached` | -This person has already verified for this particular action the maximum number of times allowed. | -Nothing to do. User cannot verify for this action again. | -
| `credential_unavailable` | -This user does not have the requested credential. | -The user must verify at the Orb or verify their unique device in World App to receive the credential required. | -
| `malformed_request` | -The request payload couldn't be decrypted or did not conform to the standard. | -Ensure IDKit is configured properly and all parameters are valid. See [above](#id-kit-react) for configuration details. | -
| `inclusion_proof_failed` | -The sequencer returned an unexpected error when retrieving the inclusion proof. | -Ask the user to try again. This may be due to a temporary network issue, or a bug with World App or the Signup Sequencer. | -
| `inclusion_proof_pending` | -The user might have the requested credential, but it is not available on-chain yet. It might be available for API verification. | -Ask the user to verify again in approximately one hour. | -
| `invalid_network` | -The application is configured for a different environment than the verifying user's client. | -Ensure you use the [Worldcoin Simulator](https://simulator.worldcoin.org) for Staging applications and World App for Production applications. | -
| `metadata_failed` | -Unable to load metadata for the app from the Developer Portal. | -Ensure your `app_id` is configured correctly in IDKit and exactly matches the `app_id` from the Developer Portal. | -
| `generic_error` | -An unhandled exception occurred. | -- Check the JS console for further details, though in most cases these will require contacting us to - report the bug. - | -
{
testingEnvironment: Environment
action: string
// maxVerifications: 0 | 1 | 2 | 3 FIXME: Enable when dynamic maxVerifications is supported
- credentialTypes: Array
+ verification_level: VerificationLevel
}>({
mode: 'all',
defaultValues: {
@@ -252,7 +251,7 @@ const Try = (): JSX.Element => {
testingEnvironment: 'production',
action: 'test-action',
// maxVerifications: 1, FIXME: Enable when dynamic maxVerifications is supported
- credentialTypes: [CredentialType.Orb],
+ verification_level: VerificationLevel.Orb,
},
})
@@ -272,8 +271,8 @@ const Try = (): JSX.Element => {
})
const isTestingWidgetValid = useMemo(
- () => !errors.action && !errors.credentialTypes,
- [errors.action, errors.credentialTypes]
+ () => !errors.action && !errors.verification_level,
+ [errors.action, errors.verification_level]
)
const authLink = useMemo(() => {
@@ -488,21 +487,21 @@ const Try = (): JSX.Element => {
*/}
- Accepted credentials
+ Minimum Verification Level
@@ -513,17 +512,16 @@ const Try = (): JSX.Element => {