Reveal data stored in the Payrails Vault. An item is addressed by record identifier, by record alias, or
by field alias, and a single request can mix all three.
The response returns one entry per requested item. Match a result to what you sent by the keys it
carries rather than by its position - a failed item echoes the key it was addressed by. An item that
cannot be resolved carries an error and does not fail the rest of the request:
request.not-found: nothing matches the key the item was addressed by. Thedetailsays which
key that was -recordId,recordAliasoralias.vault.field.not-available: the field holds no value that can be revealed - it was never given one,
it expired out of volatile storage, or it reached the number of reveals allowed for it. A record
addressed byrecordIdorrecordAliasreports this only when none of its fields could be
revealed; otherwise it comes back with the fields that could.
A request holds at most 50 items. One carrying more is rejected with 413 and nothing is revealed.
Every reveal counts against what the field is allowed, so a record addressed by several items of one
request is revealed once - repeating an item costs no more of that allowance than asking once does.
This endpoint is served on the Payrails Vault host and accepts a Vault access token. It is available by
request and requires an approval by Payrails.