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 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, Artificial Intelligence, 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.2.0, 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.2.0
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.

Identifier
string
A random string that uniquely identify the resource.
isRejected
boolean
Language
stringnull
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
name
string
DocumentError
object
2 properties
id
integer
Uniquely identify a tag.
DocumentCreate
object
21 properties
ExpiryTime
stringnull
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Document
object
5 properties 2 required
DocumentWarning
object
2 properties
errorDetail
stringnull
DocumentState
string
UserNullable
objectnull
5 properties
File
string
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX
ValidationRule
object
A validation rule for a collection
2 properties 2 required
User
object
5 properties
Tag
object
4 properties 4 required
DocumentMeta
object
39 properties 3 required
DocumentUpdate
object
14 properties
DocumentFormat
string
skipParse
boolean
customIdentifier
stringnull
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
Extractor_properties-identifier
string
Uniquely identify an extractor.
PaginatedResponse
object
3 properties 1 required
identifier
string
Uniquely identify a workspace.
isArchived
boolean
RejectDuplicatesMaybeString
booleannull
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…
errorCode
stringnull
RegionBias
objectnull
4 properties
properties-identifier
string
Uniquely identify a collection.
RequestError
object
2 properties 2 required
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…
DateRange
string
DocumentMeta_properties-identifier
string
Unique identifier for the document
PageMeta
object
7 properties 6 required
validatable
boolean
FileName
stringnull
Optional filename of the file
isConfirmed
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
Where this information came from

This is an independent, third-party profile of Affinda Documents 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.