Start onboarding

URL Expired

The URL for this request expired after 30 days.

API Parameters

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

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

• externalCustomerId
  string
  Id that identifies user in clients external system.

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

• configurationId
  string
  Id of the flow to be used for this onboarding.

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

• integrationReference
  string
  Optional integration reference.

• urlUuid
  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}

• api-version
  string
  (required) Defaults to 1.0

Example Request

curl --request POST \
     --url https://demo-api.incodesmile.com/omni/start \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json'

Response Status Codes

• 200
• 400
  Custom error statuses:
  • 4026: Invalid uuid parameter
  • 4027: Invalid configurationId
  • 4028: Flow is not activated
  • 4081: Invalid parameters for validation
  • 4082: Start endpoint version forbidden in flow/workflow