How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

7 operations 4 paths 11 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

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.

Validation Results 7

Operations to manage validation results. Validation results track the status and outcomes of document validation processes.

GET
/v3/validation_results
Get list of all validation results
getAllValidationResults 3 params → 200400401default
POST
/v3/validation_results
Create a validation result
createValidationResult body → 201400401default
GET
/v3/validation_results/{id}
Get specific validation result
getValidationResult 1 param → 200400401default
PATCH
/v3/validation_results/{id}
Update a validation result
updateValidationResult 1 param body → 200400401default
DELETE
/v3/validation_results/{id}
Delete a validation result
deleteValidationResult 1 param → 204400401default
POST
/v3/validation_results/batch_create
Batch create validation results
batchCreateValidationResults body → 201400401default
POST
/v3/validation_results/batch_delete
Batch delete validation results
batchDeleteValidationResults body → 204400401default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ValidationResult (6 properties), ValidationResultCreate (5 properties), ValidationResultUpdate (5 properties), RequestError (2 properties). Each schema is shown below with its type and property counts.

annotations
array
List of annotation ids that were validated
ValidationResult
object
Validation result arising from a ValidationRule
6 properties 6 required
ValidationResultUpdate
object
5 properties
ValidationResult_properties-id
integer
Validation Result's ID
passed
booleannull
Whether the validation passed or not, null if the validation was not applicable
message
string
Message explaining why the validation failed
RequestError
object
2 properties 2 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
ruleSlug
string
The kebab-case slug of the validation rule that was applied
BatchDeleteValidationResultsRequest
object
1 property 1 required
ValidationResultCreate
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-validation-results-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations API
Affinda Tags API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API
Where this information came from

This is an independent, third-party profile of Affinda Validation Results API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.