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

ID Analyzer Scanner API

Document scanning and OCR operations

ID Analyzer Scanner API is one of 13 APIs that ID Analyzer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scanner. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 2 base URLs: https://api2.idanalyzer.com, https://api2-eu.idanalyzer.com.

3 operations 3 paths 6 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api2.idanalyzer.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

ID Analyzer Scanner API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyHeader). By default, every request must be authenticated.

  • ApiKeyHeader — API key obtained from portal2.idanalyzer.com

Paths & Operations 3

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

Scanner 3

Document scanning and OCR operations

POST
/scan
Full KYC document scan
scan body → 200400401429
POST
/quickscan
Quick OCR document scan
quickScan body → 200400401
POST
/veryquickscan
Very quick OCR document scan
veryQuickScan body → 200400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ScanRequest (21 properties), ScanResponse (8 properties), QuickScanResponse (3 properties), QuickScanRequest (3 properties). Each schema is shown below with its type and property counts.

QuickScanRequest
object
3 properties 1 required
ScanResponse
object
8 properties
QuickScanResponse
object
3 properties
ErrorObject
object
2 properties
ErrorResponse
object
1 property
ScanRequest
object
21 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

idanalyzer-scanner-api-openapi.yml Raw ↑

Other APIs ID Analyzer publishes across the network.

ID Analyzer Biometric API
ID Analyzer AML Screening API
ID Analyzer DocuPass API
ID Analyzer Transaction Vault API
ID Analyzer Account API
ID Analyzer AML API
ID Analyzer Biometric API
ID Analyzer Contract API
ID Analyzer Docupass API
ID Analyzer Profile API
ID Analyzer Transaction API
ID Analyzer Webhook API