API Reference

Custom Fields

Custom Fields are extra fields that can be defined on the Application, Business or Person objects.

Use them to add any fields specific to your needs. See the Guide section about Custom Fields for more information.

The Custom Field object looks like:

{
	"id": "CF1618",
	"display_name": "Internal Customer ID",
	"name": "internal_customer_id",
	"description": null,
	"type": "string",
	"enabled_for": ["business_case", "person_case"],
	"is_required": false,
	"display_in_portal": true,
	"required_in_portal": false,
	"accepted_values": null,
	"display_order_in_portal": null,
	"portal_activation_condition_id": null,
	"created_at": "2024-08-30T12:33:55.024461Z",
	"updated_at": "2024-10-16T21:02:52.083035Z"
}

When creating a Custom Field, you can specify for which entities the Custom Field is for through the enabled_for attribute.

You can use a combination of the following values:

  • business_case: enable the custom field for a business case (a case verifying a business).
  • person_case: enable the custom field for a person case (a case verifying a person).
  • shareholder_business: enable the custom field for a related business with a shareholder role
  • director_business: enable the custom field for a related business with a director role
  • other_business: enable the custom field for a related business without any role
  • shareholder_person: enable the custom field for a related person with a shareholder role
  • director_person:enable the custom field for a related person with a director role
  • ubo: enable the custom field for a related person with a UBO role
  • account_owner: enable the custom field for a related person with a account_owner (signatory) role
  • other_person: enable the custom field for a related person without any role

Once a Custom Field is registered, it can be added to Cases by setting/updating the Application's custom_fields attribute. Likewise for the Person or Business objects.

For an example on how to create and use a Custom Field, see this recipe.