Business vault
The Footprint business vault is structured as a key-value store. The keys may only be a set of pre-defined "Data Identifiers," though there are many wildcard Data Identifiers.
Using predefined Data Identifiers allows Footprint to automatically validate and clean certain strongly-typed data. For example, Footprint will always validate and guarantee that business.tin is a nine-digit number representing a US Taxpayer Identification Number.
If you would like to vault information under your own application-defined keys, you may use the custom.* Data Identifiers. These have no validation and can be any JSON value: string, number, list, or object.
You can find more information on the set of supported Data Identifiers and their validators here.
Endpoints
- patch/businesses/{fp_bid}/vaultUpdate a business's vault
- post/businesses/{fp_bid}/vault/validateValidate a vault data update
- post/businesses/{fp_bid}/vault/decryptDecrypt data from a business's vault
- get/businesses/{fp_bid}/vaultCheck presence of data in a business's vault
- delete/businesses/{fp_bid}/vaultDelete data from a business's vault