Documentation
OpenAPI 3.1 spec, code examples, and live Swagger UI.
Swagger UI
Interactive API explorer
Test endpoints right from your browser. Includes auth flow.
OpenAPI 3.1
openapi.json
Raw spec. Import into Insomnia, Postman, or generate clients.
GitHub
SDKs + Action + Fixtures
Node, Python, Go SDKs. GitHub Action. 50 test fixtures.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/validate | Sync validation. Body: XML. |
| POST | /v1/validate/batch | Async batch. Returns job_id. |
| GET | /v1/jobs/{job_id} | Poll batch status. |
| POST | /v1/keys | Create API key. |
| DEL | /v1/keys/{id} | Revoke API key. |
| GET | /v1/usage | Current month usage. |
| GET | /v1/health | Liveness check. |
Authentication
All endpoints (except /v1/health) require a Bearer API key:
Authorization: Bearer evk_live_<your-key-here>
Rate limits
Per-API-key per calendar month:
- · Free: 100 validations
- · Starter: 5,000 validations
- · Pro: 20,000 validations
- · Scale: 100,000 validations
Overage: requests above your included monthly allowance return HTTP 429 until the next monthly reset. Returns429 Too Many Requests when quota exhausted.