Introduction

This guide demonstrates how to set up Custom Fields for Guarantor, with specific instructions for both Personal Guarantor and Third-Party Guarantor types.


Acceptance Criteria

To create a custom field for Guarantor, navigate to the creation popup and set the ‘Category’ to Guarantor Related.


Then, from the Field Type dropdown, select either 'Personal Guarantor Information' or 'Third-Party Guarantor Information'. This choice determines which guarantor type (Personal or Third-Party) this custom field will apply to.

Field Format
The Field Format is preset to Short Text. This means the student will be able to enter their guarantor information in a text field on the Student Portal (SP).

Label Name
Next, enter the Label Name. This is the field name that will be displayed to students within the Guarantor Information section on the SP.

API Field Name
The API Field Name is a critical technical identifier used for integration with external systems (e.g., NetSuite).

  • Once set, this value cannot be changed.

  • It must be unique across all custom fields within the same property and the same academic year.


Finally, configure the visibility and requirement settings:

Display in Booking Journey

  • This toggle switch is enabled by default. 
  • When enabled, the field will be visible and editable for students during the booking process.

Mandatory on Booking Journey

  • This toggle switch is disabled by default. 
  • When enabled, students will be forced to provide an value before they can proceed to sign booking contract, making the field mandatory.