Detokenize records and aliases

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. The detail says which
    key that was - recordId, recordAlias or alias.
  • 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 by recordId or recordAlias reports 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.

Body Params

Items to detokenize.

items
array
required
length between 1 and 50

Items to reveal. A request holds at least 1 and at most 50 items. Records and aliases can be
mixed in one request, and the same record or alias may be addressed by more than one item -
each item gets its own result, and the record is revealed once however many items ask for it.

items*
uuid
required

Payrails unique identifier of the record to reveal.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json