Skip to main content

​
🔓 Decrypt your data with simplicity and flexibility

The decryption API matches encryption functionality:
  • Simple scalar decryptions
  • Full nested object structures
  • JSON/CSV file input based payloads
  • Partial field decryption via sensitiveFields
  • Strict ACL enforcement per metadata
  • External API-based decryption
Important:

Refer to the previous section to know more about sensitiveFields DSL

go to Encrypt

​
Simple Decryption

await client.decrypt.decryptPayload({
  data: 'qanapi:encrypted-string-here=='
});
Sample response: 
"qanapi:MQ:MDFqeTc1Ym0weXFnN2t3dDlxeHl5cDB2cng:Wj06eLQuQHWsC+wisOgxPw:$"

​
Nested Object Decryption (Full)

await client.decrypt.decryptPayload({
  data: [
    {
        id: "1",
        user: {
            name: "qanapi:MQ:MDFqeTZ6eXd2c2Uya2IwcDlzMTFkd3gwYmo:gBXKoqr8xbl20V4NZFeW/Q:$",
            email: "qanapi:MQ:MDFqeTZwMzJuOHZoOTBlcHA2ZTQ1NDNycTY:pYj6pxO+5KtL6Kk++C3w8A:$"
        }
    }
  ],
});
Sample response: 
[
    {
      "id": "1",
      "user": {
        "name": "User Qanapi",
        "email": "user@qanapi.com"
      },
    }
]

​
Nested Object Decryption (Partial)

await client.decrypt.decryptPayload({
  data: [
    {
        id: "1",
        user: {
            name: "qanapi:MQ:MDFqeTZ6eXd2c2Uya2IwcDlzMTFkd3gwYmo:gBXKoqr8xbl20V4NZFeW/Q:$",
            email: "qanapi:MQ:MDFqeTZwMzJuOHZoOTBlcHA2ZTQ1NDNycTY:pYj6pxO+5KtL6Kk++C3w8A:$"
        }
    }
  ],
  sensitiveFields: ["user.email"]
});
Sample response: 
[
  {
    "id": "1",
    "user": {
        "name": "qanapi:MQ:MDFqeTZ6eXd2c2Uya2IwcDlzMTFkd3gwYmo:gBXKoqr8xbl20V4NZFeW/Q:$",
        "email": "user@qanapi.com"
    },
  }
]

​
File-Based Decryption

await client.decrypt.decryptPayload({
  filePath: './data.json'
});
Sample response is meant to be consistent with previous json body based payloads.

​
External API-Based Decryption

await client.decrypt.decryptPayload({
  data: {
    id: "ff8081819782e69e019783e167de03cd",
    name: "Apple MacBook Pro 16",
    createdAt: "2025-06-18T16:31:16.958+00:00",
    data: {
      year: "2019",
      price: "1849.99",
      CPU_model: "qanapi:MQ:MDFqeTBkMHd6ZThjNXM4OGhhY3E5ZDlobTA:1pmsTtDvzyhohDBy1b5wkg:$",
      Hard_disk size: "1 TB"
    }
  },
  destination: 'https://external-data-provider.com/encrypted-data'
});
Sample response: 
{
  "headers": {},
  "original": "{\"id\":\"ff8081819782e69e019783e167de03cd\",\"name\":\"Apple MacBook Pro 16\",\"createdAt\":\"2025-06-18T16:31:16.958+00:00\",\"data\":{\"year\":\"2019\",\"price\":\"1849.99\",\"CPU model\":\"Intel Core i9\",\"Hard disk size\":\"1 TB\"}}",
  "exception": null
}