Encryption

Swagger Editor

Swagger API Contract Link

Encrypts the given input value/s OR values of the object.

POST/crypto/v1/_encrypt

Body

application/json

The request body can contain an array of Encryption Requests to support bulk encryption. The key for encryption will be decided based on the tenantId. Each tenant will have its own seperate key. The value to be encrypted can be simple string OR an array of string OR can be a JSON Object. In case the value is a JSON Object, all the values will get encrypted and keys will be left untouched.

encryptionRequestsarray of EncReqObject (object)

Response

200

The returned encrypted value will have the same structure as the input value.

Body

application/json

array of object

Request

JavaScriptCurlPython

const response = await fetch('/crypto/v1/_encrypt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "encryptionRequests": [
        {
          "tenantId": "pb",
          "type": "Important",
          "value": "My email"
        },
        {
          "tenantId": "pb.jalandhar",
          "type": "Normal",
          "value": [
            "Personal",
            "Private"
          ]
        },
        {
          "tenantId": "pb.mohali",
          "type": "Normal",
          "value": {
            "userObject1": {
              "name": "John Doe",
              "mobileNumber": "98989121234"
            }
          }
        }
      ]
    }),
});
const data = await response.json();

Response

200

[]

Decrypts the given input value/s OR values of the object.

POST/crypto/v1/_decrypt

Body

application/json

Input to a decryption request may be an simple string OR an array OR a JSON Object. Every Object/Array will be navigated through to find simple strings, and those strings will be decrypted.

array of object

Response

200

The response to a decryption request will have the same structure as the input.

Body

application/json

array of object

Request

JavaScriptCurlPython

const response = await fetch('/crypto/v1/_decrypt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      [
        "896077|I/8Xwqr5MwB6UucEP8/Q5wiCHpbaNqGE",
        "896077|I+gMx6TjN0BcLxudEiYQKIDKtSlmpJY="
      ],
      {
        "userObject1": {
          "mobileNumber": "395551|eSfiPrQ1UK07d0SupYQYqbr2QFNOWSuYJYcU",
          "name": "395551|CnCzaK1ADfnx+4FINXIQ9zjnUs1ieAtz"
        }
      }
    ]),
});
const data = await response.json();

Response

200

[]

Provide signature for a given value.

POST/crypto/v1/_sign

Body

application/json

Request contains tenant id and the value that needs to be signed.

tenantIdstring

The key used for signing will be determined based on tenant id.

valuestring

The value to be signed.

Response

200

Response contains the value that has been signed and the value of signature.

Body

application/json

valuestring

The value that came with request.

signaturestring

The signature generated for the above value.

Request

JavaScriptCurlPython

const response = await fetch('/crypto/v1/_sign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenantId": "pb.amritsar",
      "value": "claim"
    }),
});
const data = await response.json();

Response

200

{
  "value": "claim",
  "signature": "436958|JLXQk7KP0y1nU3YHKLe0aq7EJp1iPEfNcIrbsgBh2u2U9aLCYfr8tVWGPud7JNQ5uiKJ1gTMFgzGU4XfTwUZDENHQ6mpFOhxH+LVVggj9QmDZk629ce2X7ju4aHuX6WDBx9/bxHstE8r5F47sP7f6ryY52HDQ5D5/8b7SX3WkkE="
}

Check if the signature is correct for the provided value.

POST/crypto/v1/_verify

Body

application/json

Request contains the value and its signature.

valuestring

The claim to be verified

signaturestring

The signature for the claim

Response

200

Response returns if the provided signature is correct for the given value.

Body

application/json

verifiedboolean

This will be true if the signature is correct according to the claim, otherwise false.

Request

JavaScriptCurlPython

const response = await fetch('/crypto/v1/_verify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": "claim",
      "signature": "436958|JLXQk7KP0y1nU3YHKLe0aq7EJp1iPEfNcIrbsgBh2u2U9aLCYfr8tVWGPud7JNQ5uiKJ1gTMFgzGU4XfTwUZDENHQ6mpFOhxH+LVVggj9QmDZk629ce2X7ju4aHuX6WDBx9/bxHstE8r5F47sP7f6ryY52HDQ5D5/8b7SX3WkkE="
    }),
});
const data = await response.json();

Response

200

{
  "verified": true
}

Deactivate the keys for the given tenant and generate new keys. It will deactivate both symmetric and asymmetric keys for the provided tenant.

POST/crypto/v1/_rotatekey

Body

application/json

Request has the name of the tenant for which the key needs to be rotated.

tenantIdstring

The tenantId for which the key needs to be changed.

Response

200

Acknowldgement if the operation was successful.

Body

application/json

acknowledgedboolean

Acknowledgement if the operation was successful.

Request

JavaScriptCurlPython

const response = await fetch('/crypto/v1/_rotatekey', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenantId": "pb.amritsar"
    }),
});
const data = await response.json();

Response

200

{
  "acknowledged": false
}