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 Docupass API

Hosted KYC verification sessions

ID Analyzer Docupass 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 Docupass. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 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.

4 operations 2 paths 6 schemas 1 DELETE2 GET1 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 Docupass 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 4

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

Docupass 4

Hosted KYC verification sessions

GET
/docupass
List Docupass sessions
listDocupass 3 params → 200401
POST
/docupass
Create Docupass session
createDocupass body → 200400401
GET
/docupass/{reference}
Get Docupass session
getDocupass 1 param → 200404
DELETE
/docupass/{reference}
Delete Docupass session
deleteDocupass 1 param → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DocupassCreateRequest (19 properties), DocupassResponse (8 properties), ErrorObject (2 properties), DocupassListResponse (2 properties). Each schema is shown below with its type and property counts.

SuccessResponse
object
1 property
DocupassListResponse
object
2 properties
ErrorObject
object
2 properties
ErrorResponse
object
1 property
DocupassCreateRequest
object
19 properties 1 required
DocupassResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

idanalyzer-docupass-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 Profile API
ID Analyzer Scanner API
ID Analyzer Transaction API
ID Analyzer Webhook API