Encryption

Decrypt data

post

This endpoint takes a list of encrypted data items, where each item is an object with key-value pairs of encrypted strings. It processes these items and returns their decrypted string counterparts

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/v1/encryption/decrypt

HTTPcURLJavaScriptPython

POST /api/v1/encryption/decrypt HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "items": [
    {
      "name": "!!4122abfe3c80d12aCgIIARImCiLfYOX3BVTIxKZAuBgoiVZFMHI9dBxsqc6JPpxTEk9K+qKwEgA="
    }
  ]
}

{
  "data": [
    {
      "name": "Sample"
    }
  ],
  "status": 200
}

Encrypt data

post

This endpoint accepts a list of data items (objects with key-value pairs of strings to be encrypted), along with options to specify if an envelope should be used for encryption, whether to include a hash of the original data, and an optional encryption provider. It returns the encrypted data and, if requested, the corresponding hash for each item.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

envelopebooleanRequired

providerstring | nullOptional

with_hashbooleanRequired

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/v1/encryption/encrypt

HTTPcURLJavaScriptPython

POST /api/v1/encryption/encrypt HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "envelope": false,
  "items": [
    {
      "email": "[e-mail]",
      "name": "Sample"
    }
  ],
  "with_hash": false
}

{
  "data": [
    {
      "email": {
        "data": "!!4122abfe3c80d12aCgIIARIuCiqD930cfZ9pBO8ok+wOxwicCaqWYzneRkY7DsrScDowKzJlUhiZ6/o971gSAA=="
      },
      "name": {
        "data": "!!4122abfe3c80d12aCgIIARImCiIMAZBfLbomGQDRboBkXhaomUUO1y2HPAWisz6NAsCG71G+EgA="
      }
    }
  ],
  "status": 200
}

Generate hash

post

This endpoint takes a list of data items (objects with key-value pairs of strings) and returns the corresponding hash value for each string provided

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

OK

application/json

500

Internal Server Error

application/json

post

/api/v1/encryption/hash

HTTPcURLJavaScriptPython

POST /api/v1/encryption/hash HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "items": [
    {
      "name": "Sample"
    }
  ]
}

{
  "data": [
    {
      "name": "332a38e73f86e1e0"
    }
  ],
  "status": 200
}

Provider list

get

This endpoint retrieves the encryption provider configuration. It returns the ID encryption provider.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/encryption/provider

HTTPcURLJavaScriptPython

GET /api/v1/encryption/provider HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "database": {
      "default": true,
      "id": "env",
      "key_prefix": "ENC_KEY_V"
    }
  },
  "status": 200
}