Fields supported in the Basic Information step

Learn about the fields supported in the Basic Information step of the Registration wizard, including field types, validation rules, and nesting requirements

The Registration wizard can accept and process only specific data within the Basic Information step. The tables below outline the fields supported for this step:

For each field, it's indicated whether it can be used independently or must be nested within a specific group.

Field names must be specified exactly as provided in the Name column. Field labels that will be displayed on the Sign Up page in the B2CORE UI can be amended according to your preferences.

In addition, specific data validation rules that should be assigned to the fields are listed in the Validation rules column.

For descriptions of all available field types and data validation rules that can be assigned to the fields, refer to Field types and Validation rules.

Email, password, and password confirmation fields

The table below provides information about the fields for entering an email, setting a password, and confirming the password, including field types, validation rules, and additional attributes for proper configuration.

Name Field type Label Validation rules Nesting requirements Additional attributes
email input Email required
email:rfc,spoof,strict
unique_active_email
No
password passwordButton Password required
password_length
password_content
No Label hint — specify password_hint
password_confirmation passwordButton Password confirmation required
same:password
No Label hint — specify password_confirmation_hint

{/* ### Example

This example demonstrates how to add the field for confirming the password.

User Registration step

Password confirmation */}

First name, last name, and birthday fields

The table below outlines the fields for entering a first name, last name, and birth date. These fields must be nested within the group field named info.

Name Field type Label Validation rules Nesting requirements Additional attributes
info group No
givenName input First name required
string
min:1
max:30
info_name
Must be nested in the info group
familyName input Last name required
string
min:1
max:30
info_name
Must be nested in the info group
birthday date Birth date required
date
age:18
Must be nested in the info group

{/* ### Example

This example illustrates how to add the info group, which is necessary for including the fields for entering the client's first and last names.

Info group

Info group */}

Address fields

The table below outlines the fields for entering address information. These fields must be nested within the group field named 0, which must in turn be nested within the group named addresses.

Name Field type Label Validation rules Nesting requirements Additional attributes
addresses group required
array
No
0 group Must be nested in the addresses group
country_code select Country required
nullable
countries_handbook
Must be nested in the 0 group Options type (endpoint) — specify /api/v1/countries
Options type (type) — specify Countries
For usage details, refer to the example provided below the table.
state input State required
string
min:1
Must be nested in the 0 group
postal_code input Postal/Zip Code required Must be nested in the 0 group
city input City required
string
min:1
Must be nested in the 0 group

{/* ### Example

This example demonstrates how to add the addresses group, which includes the nested group named 0. Both groups are necessary to include a field for selecting a country. To automatically specify all countries configured in your system as selection options for the field, specify /api/v1/countries in the Options type (endpoint) filed and select Countries in the Options type (type) dropdown.

Address fields

Address fields */}

Phone fields

The table below outlines the field for entering a phone number. This field must be nested within the group field named 0, which must in turn be nested within the group named phones.

Name Field type Label Validation rules Nesting requirements Additional attributes
phones group required
array
No
0 group Must be nested in the phones group
phone input Phone number required
distinct
phone:AUTO
Must be nested in the 0 group Mask key — specify phone

{/* ### Example

This example illustrates how to add the phones group, which includes the nested group named 0. Both groups are necessary to include the field for entering a phone number.

Phone fields

Phone fields */}

The table below outlines the fields required for client consent. These fields are essential for obtaining necessary agreements and consents from clients. These fields must be nested within the group field named requirements.

Name Field type Label Validation rules Nesting requirements Additional attributes
requirements group array No
pdp boolean labels.agreement

This label is used to include a link to the document containing the terms and conditions that clients must agree to.
required
boolean
requiredValue
Must be nested in the requirements group
adult boolean I am an adult required
boolean
requiredValue
Must be nested in the requirements group
resident boolean I am not a US, Iran, or North Korea resident required
boolean
requiredValue
Must be nested in the requirements group

Last updated on

On this page