Affinda Validation Results API
Track the status and findings of validation rules attached to parsed documents. Validation results record passes, failures, and remediation context for field-level rules and inform the embeddable validation UI. Supports batch create and delete.
Affinda Validation Results API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Validation, Quality, and Human in the Loop. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 7 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against a single base URL, https://{region}.affinda.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Affinda Validation Results API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Operations to manage validation results. Validation results track the status and outcomes of document validation processes.
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ValidationResult (6 properties), ValidationResultUpdate (5 properties), ValidationResultCreate (5 properties), RequestError (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Affinda 12
Other APIs Affinda publishes across the network.