Skip to main content

Version: 18.11 (EOL)

Applicants

The applicants property defines the properties that Workspaces displays on the details view under the Applicants card. The following types of applicants are suppported:

  • "PrimaryApplicant": the main applicant.
  • "SecondaryApplicant": the secondary applicant in joint applications.

Properties

All properties are optinoal unless otherwise indicated.

Applicants

PropertyDescription
$applicantMap<Applicant> (Default: null)
Required. Applicant.

Applicant

PropertyDescription
labelString (Default: null)
Required. Text to be displayed as the applicant title.
propertiesList<Mapping> (Default: [])
Required. List of property Mapping keys.

Examples

Default applicants config
"applicants": {
"PrimaryApplicant": {
"label": "Primary",
"properties": ["$primaryApplicant", "$primaryEmail", "$primarySSN"]
},
"SecondaryApplicant": {
"label": "Secondary",
"properties": ["$secondaryApplicant", "$secondaryEmail", "$secondarySSN"]
}
},