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

Contract template management and document generation

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

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

6 operations 3 paths 8 schemas 1 DELETE2 GET3 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 Contract 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 6

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

Contract 6

Contract template management and document generation

POST
/generate
Generate contract document
generateContract body → 200400401
GET
/contract
List contract templates
listTemplates 4 params → 200401
POST
/contract
Create contract template
createTemplate body → 200400401
GET
/contract/{templateId}
Get contract template
getTemplate 1 param → 200404
POST
/contract/{templateId}
Update contract template
updateTemplate 1 param body → 200400404
DELETE
/contract/{templateId}
Delete contract template
deleteTemplate 1 param → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TemplateResponse (8 properties), TemplateCreateRequest (5 properties), ContractGenerateRequest (4 properties), ContractGenerateResponse (3 properties). Each schema is shown below with its type and property counts.

TemplateResponse
object
8 properties
SuccessResponse
object
1 property
ContractGenerateRequest
object
4 properties 1 required
TemplateCreateRequest
object
5 properties 2 required
ErrorObject
object
2 properties
ErrorResponse
object
1 property
ContractGenerateResponse
object
3 properties
TemplateListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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