Suggestion: make it clear that User-Agent must be specified in request

Open Beginner friendly
#82 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

Research direction

Locate the documentation page covering requests to developer.world.org/api/v4/verify/rp_... and read its existing request examples. Add clear guidance that requests need a User-Agent to avoid Cloudflare bot-protection 403 responses, with the header shown in the example. Done means builders can see where and how to specify the header.

Written by the indexing model from the issue text.

Description

Hitting developer.world.org/api/v4/verify/rp_... with the wrong header leads to Cloudflare's bot protection 403, when there's no user agent.

Would be helpful if this was made clear to builders/LLMs, something like

Add a user agent to your request to avoid getting blocked by Cloudflare's bot protection rules.

headers: {
  'Content-Type': 'application/json',
  'User-Agent': '{INSERT YOUR USER-AGENT}'
Dominant language
MDX
Stars
10
Forks
19
Avg merge
6h 28m
Merged PRs (30d)
21

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from worldcoin/developer-docs

All issues in worldcoin/developer-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.