Appearance
Components
Components define the available profile field types in the schema. Each component has a unique id, a kind that determines its type, and configuration options including validation rules and metadata.
Understanding Component Structure
When reading a component in the schema, all components share a common base structure:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique component identifier (used to reference this component) |
kind | string | Yes | Component type: text, choice, date, address |
metadata | object | No | Component-specific metadata |
rules | object | No | Validation rules (includes optional required) |
filter | object | No | Filter configuration |
lockedAfterEdit | boolean | No | Whether the field is locked after first edit |
completionPoints | number | No | Points awarded for completing this field |
Component Types
The Profile Schema supports the following component types. Each type has specific metadata and validation rules:
See the individual component documentation to understand how to read and interpret each component type's specific configuration.