API Reference
DocumentationAPI Referenceincode.com

Start onboarding

post
https://demo-api.incodesmile.com/omni/start

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.

Body Params
string

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

string
deprecated

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

string

Id that identifies user in clients external system.

string

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

string

Id of the flow to be used for this onboarding.

string

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

string

Optional integration reference.

string

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

customFields
object

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

Headers
string
required
Defaults to 1.0
Responses

Updated 11 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago