1. Hoox Encrypt

This page explains the Hoox Encrypt API call

Why Encryption is Important?

Hoox is a zero knowledge platform. That means that we never handle, collect or keep private data. Therefore, to generate the best offer to your customers, Hoox uses a patent pending, hashing algorithm that turns email addresses and phone numbers into a irreversible cipher (hash). You'll achieve that by calling Hoox Encrypt API call.

When Should You Send This Call

1. Just before calling Hoox Request Offer - to generate hashes from the buyer's phone number and email. The response object of this call contains a userHashes array that should be sent later in the Offer Request API call.

2. Right after the buyers had completed their purchase - to encrypt the last 4 digits of the paying card. Even though it is not personal data, it's a good practice to not send it as plain text.

Hoox data encryption service.

post

Encrypt data such as emails and phone numbers using Hoox service. This service must be registered with Hoox before usage.

Body

Payload to send in the hooxEncrypt request body.

merchantIdstring · stringRequired

The merchant ID provided by Hoox.

Example: mid@FdnU121922

branchIdstring · stringRequired

The branch ID provided by Hoox.

Example: is@FdnU121311

apiKeystringRequired

The API Key provided by Hoox.

Example: bc@ut654!

keyPolicystringRequired

The Key Policy key provided by Hoox.

Example: hkp254768901

datastring[]Required

Array of pieces of data to be encrypted, typically emails or passwords. Limited to 3 elements per request.

Example: ["[email protected]"]

Responses

200

Successful response

application/json

400

Bad request: invalid input, object invalid

post

HTTPcURLJavaScriptPython

POST /hooxEncrypt HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "merchantId": "mid@FdnU121922",
  "branchId": "is@FdnU121311",
  "apiKey": "bc@ut654!",
  "keyPolicy": "hkp254768901",
  "data": [
    "[email protected]"
  ]
}

{
  "operationResult": true,
  "operationId": "aAb35g*_Justre1",
  "userHashes": [
    "HaFeRtt356G3f8C068x2"
  ]
}

If you wish to integrate Hoox encryptor in your client or server, please contact us.