The Registration wizard can accept and process only specific data within the Basic Information step.
The tables below outlines the available fields that can be included in this step for clients to fill in during registration:
For each field, it's indicated whether it can be added 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.
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
* required
* email:rfc,spoof,strict
* unique_active_email
* required
* password_length
* password_content
Label hint — specify password_hint
* required
* same:password
Label hint — specify password_confirmation_hint
Example
This example demonstrates how to add the field for confirming the password.
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
* required
* string
* min:1
* max:30
* info_name
Must be nested in the info
group
* required
* string
* min:1
* max:30
* info_name
Must be nested in the info
group
* 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.
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
Must be nested in the address
group
* 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.
* required
* string
* min:1
Must be nested in the 0
group
Must be nested in the 0
group
* 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.
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
Must be nested in the phones
group
* 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.
Consent and agreement 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
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
* required
* boolean
* requiredValue
Must be nested in the requirements
group
I am not US, Iran, or North Korea resident
* required
* boolean
* requiredValue
Must be nested in the requirements
group