API Overview
TrustComponent exposes a small, stable public REST API across its products. Today it covers fetching CAPTCHA results, pushing monitoring heartbeats, and validating VAT IDs — everything else happens in the dashboard.
Base URL & paths
Section titled “Base URL & paths”https://api.trustcomponent.comEach product namespaces its endpoints under the base URL:
| Product | Path prefix |
|---|---|
| TrustCaptcha | /captcha/v2/… |
| StatusPage / Monitoring | /monitoring/v1/… |
| VAT Checker | /taxvalidation/v1/… |
Responses carry an X-API-Version header (e.g. captcha/v2) identifying the API version that served them.
Authentication
Section titled “Authentication”Most endpoints authenticate with a Project API key, sent as a bearer token:
Authorization: Bearer ak_your_key_here- API keys are per Project and prefixed
ak_. - Create and manage them under Settings → API Keys; see Projects & Services.
- A key is shown in full only once, at creation — we store only a hash. Keys can carry an expiry date.
- A key only works against its own Project’s resources.
Two endpoints use URL tokens instead of a key, so they work from a bare curl in a cron line or an email link: heartbeat pings (per-monitor hbt_… token) and alert acknowledgement (signed one-time token). See StatusPage / Monitoring.
Conventions
Section titled “Conventions”- IDs are UUIDs.
- Timestamps are ISO-8601 in UTC (e.g.
2026-07-01T10:30:00Z). - Content type is
application/jsonfor request and response bodies unless stated otherwise. - Errors use standard HTTP status codes:
401(missing credentials),403(invalid credentials or not permitted),402(Project locked or monthly quota exhausted),404(not found),422(invalid input). Each product page lists the codes specific to its endpoints.
Product APIs
Section titled “Product APIs”TrustCaptcha Fetch a verification result from your backend.
StatusPage / Monitoring Push heartbeats and acknowledge alerts.
VAT Checker Validate, batch, schedule, and fetch results.
Webhooks Receive event notifications at your endpoint.
