World ID Python API Docs | dltHub
Build a World ID-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
World ID is an anonymous proof-of-humanity service that lets apps verify users are unique humans without sharing personal identity data. The REST API base URL is https://developer.worldcoin.org/api and Requests use the app_id in the path (no bearer token required for public verify endpoint); some developer APIs use developer portal authentication..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading World ID data in under 10 minutes.
What data can I load from World ID?
Here are some of the endpoints you can load from World ID:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| verify | /v2/verify/{app_id} | POST | (response object) | Verify a World ID proof for a Cloud action |
| verify_v4 | /api/v4/verify/{rp_id} | POST | results | Verify World ID 4.0 proofs; response contains results array |
How do I authenticate with the World ID API?
Verification endpoints accept your app identifier (app_id or rp_id) as a path parameter; no Authorization header is required for the public /verify endpoints shown in docs. Other developer portal endpoints may require developer credentials via the Developer Portal.
1. Get your credentials
- Sign in or create an account at the World developer portal (https://developer.worldcoin.org or https://world.org developer pages). 2) Create a World ID application in the Developer Portal; note the provided app_id (or rp_id for v4). 3) Use that app_id when calling verification endpoints (included in the path).
2. Add them to .dlt/secrets.toml
[sources.world_id_source] app_id = "your_app_id_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the World ID API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python world_id_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline world_id_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset world_id_data The duckdb destination used duckdb:/world_id.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline world_id_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads verify and verify_v4 from the World ID API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def world_id_source(app_id=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://developer.worldcoin.org/api", "auth": { "type": "api_key", "app_id": app_id, }, }, "resources": [ {"name": "verify", "endpoint": {"path": "v2/verify/{app_id}"}}, {"name": "verify_v4", "endpoint": {"path": "api/v4/verify/{rp_id}", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="world_id_pipeline", destination="duckdb", dataset_name="world_id_data", ) load_info = pipeline.run(world_id_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("world_id_pipeline").dataset() sessions_df = data.verify.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM world_id_data.verify LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("world_id_pipeline").dataset() data.verify.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load World ID data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
If you get 404 when calling /v2/verify/{app_id}, confirm you are using the correct app_id (or rp_id for v4) from the Developer Portal; the verify endpoint uses the app id in the path rather than an Authorization header.
Verification errors and payload validation
Verification returns HTTP 200 on success with success=true; 400 or 404 for validation or app-not-found errors. Error responses include fields: success=false, code, detail, and optionally results with per-proof failure information.
Rate limiting and developer portal access
Public verify endpoints are documented without explicit rate limits; if you need higher throughput or access to additional management endpoints, use the Developer Portal and contact support for rate limits or API keys.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for World ID?
Request dlt skills, commands, AGENT.md files, and AI-native context.