Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Interview

Start onboarding

This endpoint is mandatory to start any onboarding session in Incode Omni and session can be monitored on the Incode Dashboard. And it generates token which should be used for the authentication of future subsequent calls.

post/omni/start

Headers

api-versionstring required

Request body

languagestring

Language code to be used when doing speech to text. Possible values: en-US, es-ES, pt-BR.

externalIdstring

Id that identifies user in clients system should be used for externalId. (Deprecated, use externalCustomerId instead)

externalCustomerIdstring

Id that identifies user in clients external system.

uuidstring

uuid key used in redis, can be used as an alternative to sending interviewId.

configurationIdstring

Id of the flow to be used for this onboarding.

redirectionUrlstring

Url the user will be redirected to after finishing the onboarding successfully.

integrationReferencestring

Optional integration reference.

urlUuidstring

Url uuid key used in redis. Will be validated in start if qrPhishingResistance is ON.

customFieldsobject

Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength}

Example request

{
  "externalId": "client34598",
  "externalCustomerId": "client123",
  "redirectionUrl": "https://www.google.com",
  "customFields": {
    "firstName": "Mike",
    "lastName": "Larson"
  }
}

Response

OK

interviewIdstring

Identifies the onboarding session that is initialized. Can be used for fetching data about that session in future calls.

tokenstring

Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.

interviewCodestring

This value is used for connecting to conference call.

flowType'configuration' | 'flow' | 'workflow'

(only if configurationId is sent in request). Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).

idCaptureTimeoutinteger

Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected.

idDetectionTimeoutinteger

Number of seconds after which manual capture button should be shown to the user, if ID is not detected.

selfieCaptureTimeoutinteger

Number of seconds after which manual capture button should be shown to the user, while capturing selfie.

idCaptureRetriesinteger

Number of ID captures after which user should be taken to next screen.

selfieCaptureRetriesinteger

Number of selfie captures after which user should be taken to next screen.

curpValidationRetriesinteger

Number of curp validations after which user should be taken to next screen. (only for Mexico)

clientIdstring

Customer specific clientId that corresponds to api key.

envstring

Server environment. Could be one of: stage, demo, saas.

existingSessionboolean

It's true if interviewId corresponds to an existing Onboarding Session.