Technical Reference

Errors

This page acts as a reference for the error codes returned by IDKit, the Wallet Bridge, and the Developer Portal API.

CodeDescriptionHow to fix?
failed_by_host_appAn error was thrown in the handleVerify callback.

Assess the error thrown in your handleVerify callback and resolve the issue.

connection_failedCould not establish a connection to World App.

Ask the user to check their internet connection on both devices running your application and World App. Additionally, make sure the user has the latest version of World App.

verification_rejectedUser rejected the World ID request in World App.If this was a mistake, ask the user to go through the flow again.
max_verifications_reachedThis 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_unavailableThis 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_requestThe 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 for configuration details.
inclusion_proof_failedThe 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_pendingThe 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_proofThe 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.
invalid_merkle_rootThe merkle root provided is not recognized.Ask the user to generate a new proof, the existing proof may be stale.
invalid_networkThe application is configured for a different environment than the verifying user's client.Ensure you use the Worldcoin Simulator for Staging applications and World App for Production applications.
metadata_failedUnable 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.
action_inactiveThe requested action is disabled in the Developer Portal.Enable the action or create a new action.
unexpected_responseThere 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 report the bug.

generic_errorAn unhandled exception occurred.

Check the JS console for further details, though in most cases these will require contacting us to report the bug.

Wallet Bridge

  • verification_rejected: The user rejected the verification (by closing off the World ID modal, etc.)
  • max_verifications_reached: This action only allows N verifications, and this would be the user's N+1
  • credential_unavailable: The app requested a credential the user doesn't possess.
  • malformed_request: The request payload couldn't be decrypted or did not conform to the standard.
  • inclusion_proof_failed: The sequencer returned an unexpected error when retrieving the inclusion proof.
  • inclusion_proof_pending: Future. The user might have the requested credential, but it is not available on-chain yet. It might be available for API verification.