Configure and use custom fields

Updated 1 month ago by Ainsley

Configuring custom fields
- Custom field settings
- Content types
Deactivating custom fields
Add or edit custom field data via the Portal
Add or edit custom field data via the API
See custom field data collected via forms

Custom fields are used to capture information about a profile that can't be captured through PassFort's standard fields.

You can add this information directly to the profile or it can be captured via answers on forms.

When information is captured, you can view it in the Profile data, under Custom Fields.

If the profile does not have data for any custom fields, the Custom Fields tab is not displayed.

Configuring custom fields

Let us know which custom fields you'd like to add and we'll set them up for you.

To see the custom fields we've configured for your account, log into the PassFort Portal and go to Policy Builder > Custom fields.

You can only see the Policy Builder if you have Read-only access for the Smart policies permission. If you think you should have this permission and you don't, contact the administrator of your account.

Once a custom field is configured on your account, it can be used for all relevant profiles immediately, including profiles that were created before the custom field was configured.

Custom field settings

Every custom field has these settings:

Individual and/or Company (required): Whether the custom field can be used for profiles for individuals and/or profiles for companies.
Field name (required): The name of the field that Portal users see.
Developer name (required): Sometimes known as an alias, this is the name that developers see when calling PassFort's API. If you're not sure which developer name you'd like to use, we can choose one for you.
Description (optional): The description of the field that Portal users see.
Content type (required): The type of content for the field. A full description of all the content types is below.
Do not show this field in the portal (optional): When selected, the field is not visible to Portal users when they go to Profile data > Custom Fields. The only way to see the field is through the API and (if configured) a form.

Content types

Each custom field has one of the following content types:

Multi select: Multiple options can be selected. You provide the list of options during configuration.
Single select: One option can be selected. You provide the list of options during configuration. Optionally, you can also enable users to type an answer, which is useful if their answer doesn't match any of the options provided.
Text: A free text field.
Country: One country can be selected. Countries available for selection are the ones that have ISO3 codes.
Multi country select: Multiple countries can be selected. Countries available for selection are the ones that have ISO3 codes.
URL: A free text field. When this custom field is viewed in Profile data, it's presented as a hyperlink. Note that the URL format is not validated.
Number: A whole number. Negative numbers are accepted.
Currency: An amount in a given currency. You provide the currency during configuration. Whole numbers are used for the amount, including negative numbers.
True/False: Two radio buttons. One says Yes and the other says No.
Date: A date provided in the format YYYY-MM-DD.

The content of free text fields must be no larger than 4KB. For English text, this corresponds to 4096 characters. For text in other languages, the character limit may be less.

Deactivating custom fields

If you're no longer using a custom field, we can deactivate it for you. This prevents the field from being added to more profiles.

Any profiles that already have data for this field will continue to display the information in Profile data, but the data will no longer be editable.

Deactivated custom fields are displayed at the bottom of the custom fields list when you go to Policy Builder > Custom fields.

Deactivated custom fields can be reactivated at any time. Contact us if you'd like to make the change.

Add or edit custom field data via the Portal

To add/edit the data for a custom field:

Go to the profile you'd like to add the information to.
Click Profile data.
Click the Edit icon and select Edit custom fields. The Edit custom fields dialog is displayed, showing every custom field that can be used for the profile type.
Add or edit the information as required.
Click Save. All custom fields with data are displayed under Profile data > Custom Fields.

Add or edit custom field data via the API

Custom fields are stored in the collected_data.custom_fields_data object.

Get the step-by-step instructions for updating a profile's collected_data or check out the Update collected data resource in the API reference.

See custom field data collected via forms

Forms can be configured so when a customer answers a question, the data is added to or updated for a custom field.

If the custom field is set up so that it's visible in the Portal, the data is displayed in Profile data > Custom Fields.

Otherwise, the only way to see the custom field is for a developer to get the profile's collected_data via the API.

The Do not show this field in the portal configuration option determines whether the custom field is visible in the Portal.