Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Affinda Documents API

Upload documents (PDF, images, DOCX, XLSX, TXT, HTML) and Affinda returns structured JSON extraction with confidence scores, bounding boxes, and OCR text. Supports invoices, resumes, receipts, contracts, passports, and custom document types. 20 MB file size limit (5 MB for resumes), 20 pages default. Returns parsing status, raw text, parsed fields, and original file references.

Affinda Documents API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Document Processing, Document Extraction, AI, and OCR. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, a JSON-LD context, and 1 JSON Schema.

This API exposes 6 operations across 3 paths, and defines 38 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.

6 operations 3 paths 38 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Affinda Documents 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 6
GET
/v3/documents
Get list of all documents
getAllDocuments 20 params → 200400401403default
POST
/v3/documents
Upload a document for parsing
createDocument 1 param body → 200201400401403default
GET
/v3/documents/{identifier}
Get specific document
getDocument 4 params → 200400401default
PATCH
/v3/documents/{identifier}
Update a document
updateDocument 3 params body → 200400401default
DELETE
/v3/documents/{identifier}
Delete a document
deleteDocument 1 param → 204400401default
GET
/v3/documents/{identifier}/redacted
Get redacted document
getRedactedDocument 1 param → 200400401default

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are DocumentMeta (39 properties), DocumentCreate (21 properties), DocumentUpdate (14 properties), PageMeta (7 properties). Each schema is shown below with its type and property counts.

RegionBias
object
4 properties
skipParse
boolean
DocumentFormat
string
id
integer
Uniquely identify a tag.
DateRange
string
customIdentifier
string
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
DocumentMeta
object
39 properties 3 required
isConfirmed
boolean
DocumentState
string
RequestError
object
2 properties 2 required
errorDetail
string
DocumentMeta_properties-identifier
string
Unique identifier for the document
Document
object
5 properties 2 required
Tag
object
4 properties 4 required
Identifier
string
A random string that uniquely identify the resource.
PaginatedResponse
object
3 properties 1 required
identifier
string
Uniquely identify a workspace.
File
string
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX
ExpiryTime
string
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
properties-identifier
string
Uniquely identify a collection.
DocumentError
object
2 properties
ValidationRule
object
A validation rule for a collection
2 properties 2 required
Language
string
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
FileName
string
Optional filename of the file
errorCode
string
DocumentWarning
object
2 properties
DocumentCreate
object
21 properties
PageMeta
object
7 properties 6 required
name
string
isArchived
boolean
User
object
5 properties
validatable
boolean
Extractor_properties-identifier
string
Uniquely identify an extractor.
RejectDuplicatesMaybeString
boolean
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document…
DocumentUpdate
object
14 properties
UserNullable
object
5 properties
Wait
boolean
If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET en…
isRejected
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-documents-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations API
Affinda Validation Results 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