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

Acuant Document Instances API

Create and manage document processing sessions

Acuant Document Instances API is one of 13 APIs that Acuant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document Instances. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 4 base URLs: https://us.acas.acuant.net, https://eu.acas.acuant.net, https://aus.acas.acuant.net, https://preview.acas.acuant.net.

3 operations 2 paths 9 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://services.assureid.net
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Acuant Document Instances API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication. Credentials encoded as Base64("username:password") in the Authorization header.
  • BearerAuth — JWT bearer token obtained from the /api/v1/token endpoint.

Paths & Operations 3

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

Document Instances 3

Create and manage document processing sessions

POST
/Document/Instance
Create document processing instance
createDocumentInstance body → 200401403500
GET
/Document/{instanceId}
Retrieve document processing results
getDocumentResult 1 param → 200401404500
DELETE
/Document/{instanceId}
Delete document instance
deleteDocumentInstance 1 param → 200401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are DocumentType (6 properties), DocumentCreateRequest (5 properties), DocumentImage (5 properties), Document (5 properties). Each schema is shown below with its type and property counts.

DocumentType
object
6 properties
Error
object
2 properties
DeviceType
object
3 properties
DocumentClassification
object
2 properties
DocumentField
object
3 properties
Document
object
5 properties
DocumentImage
object
5 properties
DocumentCreateRequest
object
5 properties 1 required
DeviceInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acuant-document-instances-api-openapi.yml Raw ↑

Other APIs Acuant publishes across the network.

Acuant AssureID Connect API
Acuant FRM Face Recognition API
Acuant Passive Liveness API
Acuant ACAS (Cloud Authentication Service) API
Acuant Ozone API
Acuant Authentication API
Acuant Chip Data API
Acuant Document Data API
Acuant Face Match API
Acuant Images API
Acuant Liveness API
Acuant Metadata API