Incode Onboarding API
Create and complete onboarding sessions.
Incode Onboarding API is one of 6 APIs that Incode publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Incode Onboarding 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 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Create and complete onboarding sessions.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are StartSessionResponse (3 properties), StartSessionRequest (3 properties), FinishStatusResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Incode 5
Other APIs Incode publishes across the network.