Encryption

Encryption Service

API specs to encrypt, decrypt, sign and verify data.

PreviousEmployee NextFilestore

Last updated 1 year ago

Was this helpful?

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

post

/crypto/v1/_decrypt

Body

object[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/v1/_decrypt' \
  --header 'Content-Type: application/json' \
  --data '[["896077|I/8Xwqr5MwB6UucEP8/Q5wiCHpbaNqGE","896077|I+gMx6TjN0BcLxudEiYQKIDKtSlmpJY="],{"userObject1":{"mobileNumber":"395551|eSfiPrQ1UK07d0SupYQYqbr2QFNOWSuYJYcU","name":"395551|CnCzaK1ADfnx+4FINXIQ9zjnUs1ieAtz"}}]'

200

[
  [
    "Personal",
    "Private"
  ],
  {
    "userObject1": {
      "mobileNumber": "98989121234",
      "name": "John Doe"
    }
  }
]

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

Provide signature for a given value.

post

/crypto/v1/_sign

Body

tenantIdstring

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

valuestring

The value to be signed.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/v1/_sign' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"pb.amritsar","value":"claim"}'

200

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

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

Check if the signature is correct for the provided value.

post

/crypto/v1/_verify

Body

valuestring

The claim to be verified

signaturestring

The signature for the claim

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/v1/_verify' \
  --header 'Content-Type: application/json' \
  --data '{"value":"claim","signature":"436958|JLXQk7KP0y1nU3YHKLe0aq7EJp1iPEfNcIrbsgBh2u2U9aLCYfr8tVWGPud7JNQ5uiKJ1gTMFgzGU4XfTwUZDENHQ6mpFOhxH+LVVggj9QmDZk629ce2X7ju4aHuX6WDBx9/bxHstE8r5F47sP7f6ryY52HDQ5D5/8b7SX3WkkE="}'

200

{
  "verified": true
}

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

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

tenantIdstring

The tenantId for which the key needs to be changed.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/v1/_rotatekey' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"pb.amritsar"}'

200

{
  "acknowledged": true
}

Acknowldgement if the operation was successful.

cryptoRotateAllKeys

post

/crypto/v1/_rotateallkeys

Body

tenantIdstring

The tenantId for which the key needs to be changed.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/v1/_rotateallkeys' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"pb.amritsar"}'

200

201

401

403

404

{
  "acknowledged": true
}