User vault
The Footprint user 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 id.ssn9 is a nine-digit number representing a social security 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/users/{fp_id}/vaultUpdate a user's vault
- post/users/{fp_id}/vault/validateValidate a vault data update
- post/users/{fp_id}/vault/decryptDecrypt data from a user's vault
- get/users/{fp_id}/vaultCheck presence of data in a user's vault
- delete/users/{fp_id}/vaultDelete data from a user's vault
- post/users/{fp_id}/vault/{identifier}/uploadUpload a large file to a user's vault