All entities have an optional array of key-value pairs that can be used to provide arbitrary, additional data you wish to store. There are few limitations as to what you can add here (although the total size of the JSON entity structure - not including identity documents - should not exceed 256kb in total).
The Frankie service also makes use of these key-value pairs to provide additional functionality to our users as well. The following table provides a non-comprehensive list of keys that can be added to an entity to affect check and service behaviour.
(Note: This list is largely complete, but some customers do have bespoke additions. Contact [email protected] for any additional values that may be open to you).
Updated 12 months ago