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

Incode ID Verification API

Government ID capture and validation.

Incode ID Verification API is one of 6 APIs that Incode publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ID Verification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://demo-api.incodesmile.com, https://api.incodesmile.com.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://demo-api.incodesmile.com
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Incode ID Verification API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). An API key is passed in the header as X-Incode-Hardware-Id (SessionToken). By default, every request must be authenticated.

  • ApiKeyAuth — Client API key issued by Incode.
  • SessionToken — Session token (Onboarding Token) returned by POST /omni/start.

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.

ID Verification 3

Government ID capture and validation.

POST
/omni/add/front-id/v2
Add the front of an ID document.
addFrontId 2 params body → 200
POST
/omni/add/back-id/v2
Add the back of an ID document.
addBackId 2 params body → 200
POST
/omni/process/id
Process the captured ID.
processId 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AddIdResponse (4 properties), ProcessResponse (1 property), AddImageRequest (1 property). Each schema is shown below with its type and property counts.

AddImageRequest
object
1 property 1 required
AddIdResponse
object
4 properties
ProcessResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incode-id-verification-api-openapi.yml Raw ↑

Other APIs Incode publishes across the network.

Incode Face and Liveness API
Incode Government Validation API
Incode Onboarding API
Incode Results API
Incode Watchlist and AML API