Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

hCaptcha Siteverify API

The Siteverify API from hCaptcha — 1 operation(s) for siteverify.

hCaptcha Siteverify API is one of 6 APIs that hCaptcha publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Siteverify. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.hcaptcha.com.

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hcaptcha.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

hCaptcha Siteverify API declares 1 security scheme for authenticating requests. An API key is passed in the query as secret (secretKey). By default, every request must be authenticated.

  • secretKey — The hCaptcha secret key is passed as a form field named secret in the request body (application/x-www-form-urlencoded). It is modeled here as an apiKey scheme…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Siteverify 1
POST
/siteverify
Verify user response token
siteverify body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is SiteverifyResponse (7 properties). Each schema is shown below with its type and property counts.

SiteverifyResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hcaptcha-siteverify-api-openapi.yml Raw ↑

Other APIs hCaptcha publishes across the network.

hCaptcha Siteverify API
hCaptcha JavaScript Widget
hCaptcha Invisible
hCaptcha Mobile SDKs
hCaptcha Enterprise