Skip to content

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:

FieldTypeRequiredDescription
idstringYesUnique component identifier (used to reference this component)
kindstringYesComponent type: text, choice, date, address
metadataobjectNoComponent-specific metadata
rulesobjectNoValidation rules (includes optional required)
filterobjectNoFilter configuration
lockedAfterEditbooleanNoWhether the field is locked after first edit
completionPointsnumberNoPoints 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.