Introduction

Dynamic forms are server-driven forms that enable flexible and adaptive data collection. They allow the Enterprise API Suite to evolve form requirements — such as adding new fields for regulatory compliance — without requiring you to update your application code.

​

What are dynamic forms?

Dynamic forms are defined by API responses rather than hardcoded in your application. They consist of two parts:

• JSON Schema: Defines the data structure and validation rules
• UI Schema: Defines the layout, controls, and conditional behavior

This approach is powered by JSON Forms, an open standard for describing forms in a platform-agnostic way.

​

Why dynamic forms?

​

How dynamic forms work

When an API response includes a dynamic form, you receive a schema and a uiSchema. Your application uses these to render the form dynamically.

​

Progressive disclosure

Forms support progressive disclosure — the ability to reveal additional fields based on previous answers. When you submit partial data, the API may return an updated schema and uiSchema with new questions influenced by your submission. This creates a conversational flow where users only see relevant questions, improving the experience and data quality.

​

Prefilled forms

Some forms can be rendered with previously submitted data, allowing users to review and update their information. In these cases, you receive the schema and uiSchema alongside the existing data, which you can use to prefill the form.

​

Where you can find dynamic forms

​

Implementation approaches

You can implement dynamic form rendering using an official JSON Forms library or by building your own custom renderer. See Rendering for detailed guidance on both approaches.

​

Next steps