Skip to content

Use code FUN10 for 10% bonus credits

DocsCloudflare WAF

Cloudflare WAF API Reference

Pass Cloudflare WAF managed challenges and replay the cf_clearance cookie.

Read Markdown (English)

The Captcha.fun Cloudflare WAF API accepts kind, url and returns cf_clearance cookie. Send the API_KEY header, create a solve with POST /v1/request, then poll GET /v2/response/{id} until ready is true.

What you’ll need

  • Your API key
  • The URL of the page where the challenge appears
  • Optional: challengeHtml
  • A proxy, if the result must come from your own IP (cf_waf_proxy)
Use kind

Good to Know

Passes the Cloudflare managed challenge and returns the cf_clearance cookie together with the full Cookie header of the solve.

By default the challenge served for your target URL is used. If your integration captured the challenge page HTML, pass it in challengeHtml.

Important: The clearance is bound to the user agent and IP. If you replay from a different IP, use a _proxy kind with a sticky proxy.

Send the Challenge

Send the page details with your API key. You get a solve id back right away.

POSThttps://api.captcha.fun/v1/request
curl -X POST https://api.captcha.fun/v1/request \
  -H "API_KEY: CAPFUN-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "kind": "cf_waf",
  "url": "https://your-domain.example/protected-page"
}'

Response

Returns the solve id. Use it to get the result.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Started Solving"
}
Request fields5 body fields · 2 required

Headers

NameTypeRequiredDescription
API_KEYstringYesYour API key
Content-TypestringYesapplication/json
APP_IDstringNoOptional app ID for request tracking

Body

NameTypeRequiredDescription
kindstringYesOne of cf_waf, cf_waf_proxy
urlstringYesPage URL where the challenge appears
challengeHtmlstringNoCaptured challenge page HTML. Omit to use the challenge served for your target URL
proxystringNoFor _proxy kinds: host:port or host:port:username:password
platformstringNoRequested platform label: windows (default) or mac

Wait for the Result

Use the solve id to fetch the result.

GEThttps://api.captcha.fun/v2/response/{id}

Poll every second until ready is true.

Example

curl -X GET https://api.captcha.fun/v2/response/550e8400-e29b-41d4-a716-446655440000 \
  -H "API_KEY: CAPFUN-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Accept: application/json"

Response

{
  "ready": true,
  "status": "SUCCESS",
  "success": true,
  "userAgent": "RETURNED_USER_AGENT",
  "secUa": "RETURNED_SEC_CH_UA",
  "token": "v1e3b1f2e8e1a897de2ea1fa5db0d2fd8-1735689600-1.2.1...",
  "cookies": {
    "cf_clearance": "v1e3b1f2...",
    "__cf_bm": "a1b2c3d4e5..."
  },
  "cookieHeader": "cf_clearance=v1e3b1f2...; __cf_bm=a1b2c3d4e5..."
}
Request and response fields9 response fields

Request

NameTypeRequiredDescription
idstring (UUID)YesPath parameter. The id from Create Solve
API_KEYstringYesHeader. Your API key

Response Fields

NameTypeRequiredDescription
readyboolean—true when the solve is finished (v2 only)
statusstring—PENDING while solving, then SUCCESS or FAILURE
successboolean—Whether the solve succeeded
userAgentstring—Value to send as User-Agent when using the result. Preserve it exactly
secUastring—Value to send as Sec-CH-UA when using the result
tokenstring—The cf_clearance clearance cookie value minted by passing the managed challenge
cookiesobject—The defense cookie family, cookie name to value
cookieHeaderstring—The solving session's full Cookie header value, verbatim — replay it with the returned userAgent from the same egress IP
messagestring—Failure reason. Omitted on success

Send the Cookies

  • Replay cookieHeader as the Cookie header on outbound requests to the protected origin, with the returned userAgent as your User-Agent header. The clearance is bound to both the user agent and the egress IP of the solving session.
  • Prefer the full cookieHeader value over rebuilding a cookie jar from parts — the zone typically pairs cf_clearance with a __cf_bm sibling the edge expects to travel with it.

When using a successful result, preserve the returned userAgent as User-Agent and secUa as Sec-CH-UA.

Wrong or rejected result? Report the failed solve.

More from Cloudflare