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 Government Validation API

Validation against government databases.

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

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

This API exposes 1 operation across 1 path, and defines 2 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.

1 operations 1 paths 2 schemas 1 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 Government Validation 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 1

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

Government Validation 1

Validation against government databases.

POST
/omni/process/government-validation
Validate ID data against a government database.
processGovernmentValidation 2 params body → 200

Schemas 2

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

GovernmentValidationRequest
object
2 properties
ProcessResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incode-government-validation-api-openapi.yml Raw ↑

Other APIs Incode publishes across the network.

Incode Face and Liveness API
Incode ID Verification API
Incode Onboarding API
Incode Results API
Incode Watchlist and AML API