Cloudcheck API Documentation

// Access data
String key = "lj5YozlG6cv7mm6c";
String secret = "Ur7znqOTM1KuQw2gXBt0ShDqQcHVGsAq";
String nonce = "1";
String timestamp = "1353987581461";
String data = "{\"details\":{\"address\":{\"suburb\":\"Hillsborough\",\"street\":\"27 Indira Lane\",\"postcode\":\"8022\",\"city\":\"Christchurch\"},\"name\":{\"given\":\"Cooper\",\"middle\":\"John\",\"family\":\"Down\"},\"dateofbirth\":\"1978-01-10\"},\"consent\":\"Yes\"}";

// The API call path.
String path = "/verify/";

// Set up some dummy parameters. Use a TreeMap to sort alphabetically.
Map<String, String> parameterMap = new TreeMap<>();
parameterMap.put("key", key);
parameterMap.put("nonce", nonce);
parameterMap.put("timestamp", timestamp);
parameterMap.put("data", data);

// Build the signature string from the parameters.
StringBuilder signatureString = new StringBuilder(path);
for (String param : parameterMap.keySet()) {
	if (param.equals("signature")) {
		continue;
	}

	signatureString.append(param);
	signatureString.append("=");
	signatureString.append(parameterMap.get(param));
	signatureString.append(";");
}

// Create the HMAC SHA-256 Hash from the signature string.
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key);

byte[] generatedHash = sha256_HMAC.doFinal(signatureString.toString().getBytes("UTF-8"));

// Convert the generated hash to a lowercase hexadecimal string.
String signatureHex = DatatypeConverter.printHexBinary(generatedHash).toLowerCase();

// Outputs: 53ccc8563d21393bbac5a5a693e0ba7cc408f83dfb04008122510eee9e80aa86
System.out.println(signatureHex.toString());

// Access data
$key = 'lj5YozlG6cv7mm6c';
$secret = 'Ur7znqOTM1KuQw2gXBt0ShDqQcHVGsAq';
$nonce = '1';
$timestamp = '1353987581461';
$data = '{"details":{"address":{"suburb":"Hillsborough","street":"27 Indira Lane","postcode":"8022","city":"Christchurch"},"name":{"given":"Cooper","middle":"John","family":"Down"},"dateofbirth":"1978-01-10"},"consent":"Yes"}';

// The API call path.
$path = '/verify/';

// Set up some dummy parameters. Sort alphabetically.
$parameterMap = array(
    'key' => $key,
    'nonce' => $nonce,
    'timestamp' => $timestamp,
    'data' => $data
);

ksort($parameterMap);

// Build the signature string from the parameters.
$signatureString = $path;
foreach ($parameterMap as $key => $value) {
    if ($key === 'signature') {
        continue;
    }

    $signatureString .= "$key=$value;";
}

printf("String: %s\n", $signatureString);

// Create the HMAC SHA-256 Hash from the signature string.
$signatureHex = hash_hmac('sha256', $signatureString, $secret, false);

// Outputs: 53ccc8563d21393bbac5a5a693e0ba7cc408f83dfb04008122510eee9e80aa86
printf("Signature: %s\n", $signatureHex);

// Access data
string key = "lj5YozlG6cv7mm6c";
string secret = "Ur7znqOTM1KuQw2gXBt0ShDqQcHVGsAq";
string nonce = "1";
string timestamp = "1353987581461";
string data = "{\"details\":{\"address\":{\"suburb\":\"Hillsborough\",\"street\":\"27 Indira Lane\",\"postcode\":\"8022\",\"city\":\"Christchurch\"},\"name\":{\"given\":\"Cooper\",\"middle\":\"John\",\"family\":\"Down\"},\"dateofbirth\":\"1978-01-10\"},\"consent\":\"Yes\"}";

// The API call path.
string path = "/verify/";

// Set up some dummy parameters. Use a SortedDictionary to sort alphabetically.
var parameterMap = new SortedDictionary<string, string>();
parameterMap["key"] = key;
parameterMap["nonce"] = nonce;
parameterMap["timestamp"] = timestamp;
parameterMap["data"] = data;

// Build the signature string from the parameters.
var signatureString = new System.Text.StringBuilder();
signatureString.Append(path);
foreach (KeyValuePair<string, string> param in parameterMap) {
	signatureString.Append(param.Key);
	signatureString.Append("=");
	signatureString.Append(param.Value);
	signatureString.Append(";");
}

// Create the HMAC SHA-256 Hash from the signature string.
var encoding = new System.Text.UTF8Encoding();
byte[] keyByte = encoding.GetBytes(secret);
byte[] messageBytes = encoding.GetBytes(signatureString.ToString());

using (var hmacsha256 = new HMACSHA256(keyByte)) {
	byte[] hashedMessage = hmacsha256.ComputeHash(messageBytes);

	string signatureHex = "";

	for (int i = 0; i < hashedMessage.Length; i++) {
		signatureHex += hashedMessage[i].ToString("X2"); // hex format
	}

	// Outputs: 53ccc8563d21393bbac5a5a693e0ba7cc408f83dfb04008122510eee9e80aa86
	Console.WriteLine("Signature: " + signatureHex.ToLower());
}

# Access data
key = "lj5YozlG6cv7mm6c"
secret = "Ur7znqOTM1KuQw2gXBt0ShDqQcHVGsAq"
nonce = "1"
timestamp = "1353987581461"
data = '{"details":{"address":{"suburb":"Hillsborough","street":"27 Indira Lane","postcode":"8022","city":"Christchurch"},"name":{"given":"Cooper","middle":"John","family":"Down"},"dateofbirth":"1978-01-10"},"consent":"Yes"}'

# The API call path.
path = "/verify/"

# Set up some dummy parameters. Use a TreeMap to sort alphabetically.
parameterMap = { 
  'key': key, 
  'nonce': nonce, 
  'timestamp': timestamp, 
  'data': data
}

# Build the signature string from the parameters.
signatureString = path
parameterMap.keys.sort.each { |k| signatureString << "#{k}=#{parameterMap[k].to_s};" }

# Create the HMAC SHA-256 Hash from the signature string
signatureHex = OpenSSL::HMAC.digest("sha256", secret, signatureString).unpack("H*")[0].downcase

# Outputs: 53ccc8563d21393bbac5a5a693e0ba7cc408f83dfb04008122510eee9e80aa86
puts signatureHex

import UIKit
import CommonCrypto

// Access data
let key = "lj5YozlG6cv7mm6c"
let secret = "Ur7znqOTM1KuQw2gXBt0ShDqQcHVGsAq"
let nonce = "1"
let timestamp = "1353987581461"
let data = "{\"details\":{\"address\":{\"suburb\":\"Hillsborough\",\"street\":\"27 Indira Lane\",\"postcode\":\"8022\",\"city\":\"Christchurch\"},\"name\":{\"given\":\"Cooper\",\"middle\":\"John\",\"family\":\"Down\"},\"dateofbirth\":\"1978-01-10\"},\"consent\":\"Yes\"}"

// The API call path.
let path = "/verify/"

// Set up some dummy parameters.
let params: [String: Any] = ["key": key, "nonce": nonce, "timestamp": timestamp, "data": data]

// Sort alphabetically and join together.
let paramsString: String = params.keys.sorted().map({"\($0)=\(params[$0]!);"}).joined()

// Build the signature string from the parameters.
let signatureString = path + paramsString

// Create the HMAC SHA-256 Hash from the signature string.
let cKey = secret.cString(using: .utf8)!
let cData = signatureString.cString(using: .utf8)!
var result = [CUnsignedChar](repeating: 0, count: Int(CC_SHA256_DIGEST_LENGTH))
CCHmac(CCHmacAlgorithm(kCCHmacAlgSHA256), cKey, strlen(cKey), cData, strlen(cData), &result)
let hmacData = Data(bytes: result, count: Int(CC_SHA256_DIGEST_LENGTH))

extension Data {
    /// Output the data as a lowecase hexadecimal string
    var hexEncodedString : String {
        return map({String(format: "%02hhx", $0)}).joined()
    }
}

// Outputs: 53ccc8563d21393bbac5a5a693e0ba7cc408f83dfb04008122510eee9e80aa86
print(hmacData.hexEncodedString)