World ID
docs.world.org- Category
- Onchain
- Network
- —
- Avg / request
- No payment required
- Endpoints
- 1
Service overview
What is World ID?
World ID lets an application request proof that a person holds a valid credential without revealing their identity. The operator’s application creates the proof request through IDKit and keeps its RP signing key in a trusted backend. The agent then sends the resulting proof and the World app rp_id to peaqOS, which calls the World ID verify API and records the result.
How it works
- Step 1
Create a World app
Create or select a World app, keep its RP signing key in the operator’s trusted backend, and use IDKit to request the proof.
- Step 2
Send scoped credentials
Pass rpId under providerCredentials.worldId when searching or executing through peaqOS.
- Step 3
Verify the proof
Submit the IDKit response payload in the execution input; peaqOS calls the World ID verify API and stores the run, outcome, and audit trail.
Adapter surface
1 operationAdapter operations
Behind peaqOS — the agent submits the proof payload, peaqOS calls the World ID verify API addressed by the operator’s rp_id.
- POST
/api/v4/verify/{rp_id}Verify a World ID proof using the full IDKit response; legacy v3 proof fields are also accepted.
Integration fields
Wire World ID into peaqOS
- serviceId
- world-id:{rp_id}
- skillKey
- world-id-proof-verify
- serviceType
- identity.proof-of-person
- operation
- verify-proof
- credential path
- providerCredentials.worldId.rpId
- input
- input.idkitResponse (preferred) or legacy v3 proof fields
- output
- success — verification result from the World ID verify API
- payment
- not-required — credential-gated, no payment rail
FAQ
Questions agents ask about World ID
Does it require an API key?
The peaqOS verification call needs the World app rp_id, not an API key or secret. The application creating a World ID 4.0 proof still needs an RP signing key in its trusted backend; that key is not sent to peaqOS.
How does payment work?
It does not run through peaqOS. World ID cloud proof verification is credential-gated, not payment-gated — peaqOS runs no market payment on this path and still records the order, execution, and audit receipt. Any fees World may introduce on the operator’s World app are settled with World directly.
What does the request include?
The preferred input is the full IDKit response as input.idkitResponse, which peaqOS forwards to the v4 verify API. Individual proof, merkle_root, nullifier, nonce, and action fields remain available for legacy v3 payloads.
How is repeat verification handled?
World verifies each proof against the configured RP and action. In World ID 4.0, uniqueness nullifiers are one-time-use; session_id is used for returning-user continuity. peaqOS returns the verification result but does not treat a nullifier as a permanent identity.
What happens if verification fails?
The World ID verify error — invalid proof, wrong app context, or provider error — is returned to the agent and stored on the failed order run.