BizKitHub
DocsAPI ReferenceSecurity/api/v1/security/captcha-verify
getSecurityPublic API v1

/api/v1/security/captcha-verify

Verifies whether the user-entered captcha code matches the generated one. Returns status: "match" (correct), "miss" (wrong code), or "expired-token" (token no longer valid).

securitygetApiV1SecurityCaptcha-verify

Parameters

2 query

Query parameters

· 2
tokenstringRequired

Captcha token returned by the /captcha endpoint.

Examplemfuunpqsqa1rw8ft
codestringRequired

User-entered captcha code.

ExampleNU3BX

Response schema

1 status code documented

200Success
tokenstringRequired

The token that was verified.

Examplemfuunpqsqa1rw8ft
codestringRequired

The code that was submitted.

ExampleNU3BX
statusstringRequired

Verification result.

Examplesmatchmissexpired-token

Response example

application/json
{
  "token": "mfuunpqsqa1rw8ft",
  "code": "NU3BX",
  "status": "match"
}

Request example

GET /api/v1/security/captcha-verify

get
curl -X GET "https://api.bizkithub.com/api/v1/security/captcha-verify?token=mfuunpqsqa1rw8ft&code=NU3BX" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key