World Developer Docs

curl --request POST \
  --url https://developer.world.org/api/v4/verify/{rp_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol_version": "3.0",
  "nonce": "0xabc123",
  "action": "my_action",
  "responses": [
    {
      "identifier": "orb",
      "merkle_root": "0x2264a66d162d7893e12ea8e3c072c51e785bc085ad655f64c10c1a61e00f0bc2",
      "nullifier": "0x2bf8406809dcefb1486dadc96c0a897db9bab002053054cf64272db512c6fbd8",
      "proof": "0x1aa8b8f3b2d2de5ff452c0e1a83e29d6bf46fb83ef35dc5957121ff3d3698a1119090fb...",
      "signal_hash": "0x00c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a4",
      "max_age": 304200
    }
  ]
}
'

{
  "success": true,
  "results": [
    {
      "identifier": "<string>",
      "success": true,
      "nullifier": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ],
  "action": "<string>",
  "nullifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "session_5f3a9c2e...8d1b0a",
  "message": "<string>"
}

POST

/

api

/

v4

/

verify

/

{rp_id}

curl --request POST \
  --url https://developer.world.org/api/v4/verify/{rp_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol_version": "3.0",
  "nonce": "0xabc123",
  "action": "my_action",
  "responses": [
    {
      "identifier": "orb",
      "merkle_root": "0x2264a66d162d7893e12ea8e3c072c51e785bc085ad655f64c10c1a61e00f0bc2",
      "nullifier": "0x2bf8406809dcefb1486dadc96c0a897db9bab002053054cf64272db512c6fbd8",
      "proof": "0x1aa8b8f3b2d2de5ff452c0e1a83e29d6bf46fb83ef35dc5957121ff3d3698a1119090fb...",
      "signal_hash": "0x00c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a4",
      "max_age": 304200
    }
  ]
}
'

{
  "success": true,
  "results": [
    {
      "identifier": "<string>",
      "success": true,
      "nullifier": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ],
  "action": "<string>",
  "nullifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "session_5f3a9c2e...8d1b0a",
  "message": "<string>"
}

Path Parameters

rp_id

string

required

RP ID (rp_...) is recommended. App ID (app_...) is also accepted for backward compatibility.

Body

application/json

Legacy Proofs (v3)
Uniqueness Proofs
Session Proofs

Choose one request type.

protocol_version

enum<string>

required

Available options:

3.0

nonce

string

required

action

string

required

responses

object[]

required

Minimum array length: 1

Show child attributes

action_description

string

environment

enum<string>

default:production

Available options:

production,

staging

user_presence_completed

boolean

Whether World App completed the requested user-presence check. IDKit always sends it; treat a missing value as false.

Response

At least one proof verified successfully

success

enum<boolean>

required

Available options:

true

results

object[]

required

Show child attributes

action

string

nullifier

string

created_at

string<date-time>

environment

enum<string>

Available options:

production,

staging

session_id

string

Opaque session ID in the format session_<128 hex characters>.

Example:

"session_5f3a9c2e...8d1b0a"

message

string

⌘I