API reference
Build verification into a business workflow, with separate paths for decided results and the records that still need review.
New here? Send your first request with a complete cURL, Python or JavaScript example. You can also download the Postman collection or open the API schema. The current free plan includes console and API access.
The base URL is https://openauditor.ai/api. Endpoint paths begin /v1, so a single verification is sent to https://openauditor.ai/api/v1/verify. Requests and responses use JSON.
Choose the operation you need
| Guide | Use it to |
|---|---|
| Authentication | Create a key, authenticate a request and inspect the running configuration. |
| Verify an item | Submit one record or decision with the context required by its checks. |
| Verification results | Interpret verdicts, assertion outcomes, evidence, risk and measured certainty. |
| Batch audits | Queue a population, follow progress and retrieve filtered, paged results. |
| Review marks | Record whether a human reviewer found an audit verdict correct. |
| Schemas and discovery | Inspect supported record types, context requirements and generated JSON Schemas. |
Endpoint directory
This directory is generated from the service’s OpenAPI 3.1 document. GET /api/v1/health and GET /api/v1/openapi.json are also public. Public reads are cached at the edge: fresh for 60 seconds, then served from the cache while it refreshes, so after a release they can lag the origin briefly. health is never served stale.
One request, a defined scope
Each request chooses one use case. Its item types and supplied context determine what the engine can check. The API does not retrieve omitted business records or execute the approval, payment or agent action being reviewed. Your application retains that business decision and acts on the returned findings.
All three verdicts—true, false and uncertain—can be successful HTTP responses. Keep request failures separate from business findings, and give unresolved items an explicit route to review.
Operate the integration
Retain the request’s Request-Id when diagnosing an HTTP problem. Preserve the verification’s configuration and input_sha256 with its source evidence when investigating a finding. Respect Retry-After when present, and plan batches within both the request-size limits and your account quotas.
Continue reading
- Quickstart — send a complete supplier-invoice example with curl, Python or JavaScript.
- Limits — plan request sizes, batch sizes and account usage.
- Error guide — identify input, authentication and temporary service failures.