Create Dictionary Field

post

https://openapi.advance.ai/v1/business/dictionaries

Creates a new custom dictionary field definition for the tenant. Dictionary fields
are used to extend KYB questionnaires and application forms with tenant-specific
data fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

displayName

string

required

Human-readable display name of the field.

aliasName

string

Alias name for the field (used as API-level key).

dictCategory

string

enum

required

Dictionary field category.

Allowed:

dictClass

string

enum

required

Dictionary field classification (which entity type it belongs to).

Allowed:

fieldType

string

enum

Data type of the dictionary field.

Allowed:

apiFieldKey

string

API field key identifier for programmatic use.

description

string

Description of the dictionary field.

valueMode

string

enum

required

How the dictionary field value is entered.

Allowed:

fieldConfig

object

Field-type-specific configuration (validation rules, constraints).

optionValues

array of objects

Predefined option values (for SINGLE_SELECT / MULTI_SELECT modes).

optionValues

compositeFields

array of objects

Sub-fields for composite dictionary fields.

compositeFields

Headers

X-Request-Id

string

Unique request identifier. Injected by the API gateway if not provided by the client.
The same value is available in the response body requestId field for business-layer tracing.

X-Trace-Id

string

Distributed tracing identifier. Injected by the API gateway if not provided by the client.
Used for cross-service request correlation in logs and monitoring.

Responses

200The newly created dictionary field definition.

400Request validation failed or malformed JSON.

401Authentication failed. Access token is missing, invalid, or expired.

429Rate limit exceeded.

500Unexpected server error.