Retrieve Data from Locker

POST /api/v2/vault/retrieve

Description: Retrieve data stored in the locker.

cURL

curl --request POST \
  --url https://api.example.com/api/v2/vault/retrieve \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_id": "<string>",
  "vault_id": "<string>"
}
'

Response (200)

Response body

{
  "data": {}
}

---

Headers

• x-tenant-id: string

---

Body (application/json)

The request body might be JWE + JWS encrypted when using middleware.

One of the request options:

• JWEReq

Request fields:

• entity_id (string) — Unique identifier for the entity

• vault_id (string) — Unique identifier for the vault

---

Response (200 - application/json)

Retrieve Data Response

• JWERes

Response fields:

• data (object)

---

Related pages:

• Add Data in Locker: https://api-reference.hyperswitch.io/locker-api-reference/locker-general-purpose-storage/add-data-in-locker

• Delete Data from Locker: https://api-reference.hyperswitch.io/locker-api-reference/locker-general-purpose-storage/delete-data-from-locker

Edit or report an issue:

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/locker-api-reference/locker-general-purpose-storage/retrieve-data-from-locker.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/locker-api-reference/locker-general-purpose-storage/retrieve-data-from-locker