Add custom fields

This endpoint is used for adding custom fields to current onboarding session. The key must match one of the keys that are defined for the Organization, and the value must be of the type that is defined for the corresponding key.

post/omni/add/custom-fields

Request

Base URL
https://demo-api.incodesmile.com
Auth
API key in header x-api-key and API key in header X-Incode-Hardware-Id
TypeScript
https://skmtc.dev/incode/apis/incode-omni-api/docs/omni/add/custom-fields/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

api-versionstring required

Request body

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

{
  "customFields": {
    "customFields": {
      "watchlistName": "Name"
    }
  }
}

Response

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status

Changes

No recorded changes to this operation across all 1 revision of this API.