Encrypt HumanID QR Code

Endpoint

POST https://api.verifik.co/v2/human-id/encrypt-qr-code

Create a HumanID and encapsulate it in a QR code. This is ideal for applications that need to display or share the HumanID via QR codes.

HumanAuthn uses encryption from zelf.world. The Verifik product field is humanIDQR.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Params

Name	Type	Required	Description
publicData	object	Yes	Public data stored with the HumanID (string key-value pairs)
metadata	object	Yes	Private metadata encrypted into the HumanID (string key-value pairs)
faceBase64	string	Yes	Base64 encoded facial image
os	string	Yes	Operating system (DESKTOP, ANDROID, IOS)
identifier	string	Yes	Unique identifier (alphanumeric only, no spaces or special characters)
requireLiveness	boolean	Yes	Require a live face when decrypting later
livenessDetectionPriorCreation	boolean	No	Require a live face when creating the HumanID
tolerance	string	No	Liveness anti-spoof strictness (SOFT, REGULAR, HARDENED, REGULAR_HARD, REGULAR_SOFT). Defaults to HARDENED when requireLiveness is true
password	string	No	Optional password for additional security
referenceFaceBase64	string	No	Optional reference face image
verifierKey	string	No	Optional verifier key
storageProvider	string	No	Store in IPFS or return without Verifik persistence (ipfs, none). Defaults to ipfs
livenessLevel	string	No	Ignored. This proxy does not forward livenessLevel; use tolerance

Request

Node.js

const fetch = require("node-fetch");

async function run() {
  const res = await fetch("https://api.verifik.co/v2/human-id/encrypt-qr-code", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
    },
    body: JSON.stringify({
      faceBase64: "<base64_image>",
      tolerance: "HARDENED",
      os: "DESKTOP",
      identifier: "random",
      publicData: {
        "a": "1",
        "b": "2"
      },
      metadata: {
        "c": "3"
      },
      requireLiveness: false
    }),
  });
  console.log(await res.json());
}

run();

PHP

<?php
$ch = curl_init("https://api.verifik.co/v2/human-id/encrypt-qr-code");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
$body = json_encode([
    "faceBase64" => "<base64_image>",
    "tolerance" => "HARDENED",
    "os" => "DESKTOP",
    "identifier" => "random",
    "publicData" => [
        "a" => "1",
        "b" => "2"
    ],
    "metadata" => [
        "c" => "3"
    ],
    "requireLiveness" => false
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Python

import os, requests

url = "https://api.verifik.co/v2/human-id/encrypt-qr-code"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
payload = {
    "faceBase64": "<base64_image>",
    "tolerance": "HARDENED",
    "os": "DESKTOP",
    "identifier": "random",
    "publicData": {
        "a": "1",
        "b": "2"
    },
    "metadata": {
        "c": "3"
    },
    "requireLiveness": False
}
r = requests.post(url, json=payload, headers=headers)
print(r.json())

Go

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    payload := map[string]interface{}{
        "faceBase64": "<base64_image>",
        "tolerance": "HARDENED",
        "os": "DESKTOP",
        "identifier": "random",
        "publicData": map[string]string{
            "a": "1",
            "b": "2",
        },
        "metadata": map[string]string{
            "c": "3",
        },
        "requireLiveness": false,
    }
    b, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.verifik.co/v2/human-id/encrypt-qr-code", bytes.NewBuffer(b))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+os.Getenv("VERIFIK_TOKEN"))
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    var out map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&out)
    fmt.Println(out)
}

Response

200

{
  "data": {
    "humanIDQR": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAIAAAB7GkOtAAA3XklEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYrXNVVddddVV/+9Queqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGV/9kk8V/CNg8giQewzb+VJB7ANg8gif8gtnkASTyAbf5zSOIBbPMAkniR2eYBJPEAtnnBJPGC2eYFk8QLZpt/K0k8gG1eZJJ4wWzzAJJ4wWzzH0QS/0Fs84JJ4gFs8wCSeMFs84JJ4gFs8yKTxAPY5gEk8QC2+R+NylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+o/M9mmweQxH8QSTyAbf4HsM2/lSQewDYvmG0eQBIvmCQewDYvmG1eMEn857DNA0jiBbPNv5VtHkAS/0Ek8QC2ecFs84JJ4kVmm38rSbzIbPMAknjBbPMAkngA2zyAJF5kkngA27xgtnkASbxgtvnfhMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqPx/ZZt/K0k8gG0eQBL/QSTxgtnmAWzzgkniAWzzIrPNi0wS/0Ek8YLZ5kVmmweQxAtmmxdMEi+YbR5AEi8y2/xbSeI/iCReZLZ5AEk8gG0eQBIPYJsHkMQLZpsHkMQD2OYBJPGC2ebfyjYvmCQewDb/o1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EbLN/2CSeADbvMgk8R/ENv9BJPGC2eYFk8QD2OYBJPF/i21eMEk8gG1eMEk8gG1eMEk8gG1eMEn8j2ebB5DEA9jm30oSD2CbB5DEi8w2/0Ek8R/ENg8giReZbf5Ho3LVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jZJv/wSTxb2WbF5kkXmS2eZFJ4j+HbR5AEg9gmxdMEg9gmxdMEi+YbR5AEi+YbV4wSbxgtnnBJPEAtvm3ksQD2OZFJokXzDb/VpJ4kdnm30oS/0Fs84JJ4gFs8wCSeMFs8yKTxAPY5gEk8SKzzQsmiQewzf9oVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5f8Q27xgknjBbPNvJYl/K9s8gCQewDYvmCT+g0jiAWzzgtnmASTxbyWJF5kkXjDbvGCSeADbPIAkXjBJvMhs84JJ4gFs84JJ4gFs84JJ4gWTxAtmmxeZbR5AEi8ySbxgknjBbPMAkngA2zyAJF4wSbxgtnkASTyAJP7voHLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jZJv/tSTxALb5t5LEi8w2/0Ek8YLZ5gWTxL+VbR5AEi+YbR5AEi+YbV5kkniR2eYFk8QD2Oa/gyQewDb/VpL4L2GbB5DEA9jmASTxgtnmASTxgtnmASTxgtnm30oSD2CbB5DEA9jmRSaJF8w2/6NRueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGV/9kk8QC2ecEk8YLZ5gEk8QC2+Q8iiQewzQNI4gFs8wCSeABJPIBt/jtI4t9KEi8y27zIJPEAtnkASfwHsc2/lSQewDYPIIn/HLZ5wSTxgtnmRWabB5DEC2abF8w2L5gkXjDbvMgk8YJJ4gFs8yKzzf8mVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X+EbPM/mCReZLb5t5LEv5VtHkASL5ht/q0k8YLZ5kUmiRfMNg8giQewzQsmiQewzQsmiQewzQNI4gFs8yKTxAPY5kUmiRfMNi8ySfxb2eYBJPFvZZsHkMQD2OYBJPE/gG1eZJJ4ANs8gCT+rWzzAJJ4kdnmfzQqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P6LyP5ttXjBJPIAkHsA2DyCJfyvb/FvZ5gWTxIvMNg8giRdMEi+YbR5AEi8ySTyAbV4wSbxgtnkASTyAbV4wSTyAbV4wSbxgtnnBbPMAknjBbPMis81/ENs8yGzzgtnmASTxALZ5AEn8W9nmASTxAJJ4ANu8YLZ5AEn8B5HE/1lUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f4Rs8z+YJB7ANi+YJB7ANv8lJPEAtnmRSeIBbPMAkvi3ss0DSOIBbPMfRBIPYJsHkMQD2OYBJPEAtnkASTyAbf6tJPEAtnkASTyAbf6tJPGC2eYFk8QD2OYBJPG/jW0eQBIvMts8gCT+c9jmASTxb2Wb/02oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1Suuuqqq676/4jK/2y2eQBJvGC2eQBJvMhs829lmxeZJB7ANv9BbPMAkngA27xgkniR2eY/iG0eQBIPYJsHkMQD2OYBJPEAtnkA2zyAJF4wSbxgtnkASTyAbV4wSTyAbf6tbPMAkngA2zyAJB7ANg8giRfMNg8giQewzQsmiQewzQNI4gFs8yKzzQsmif8gtnmRSeIBbPM/GpWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fIdv87yGJfyvbvGCSeADb/FtJ4gFs8yKTxAPY5gEk8QC2+beSxAPY5gEk8SKzzf88kngA2/xbSeJFZpsHkMQD2OYBJPGC2eYFk8QD2ObfShIPYJsHkMQD2OYBJPEAtnkASbxgtnkASbxgtnkASbxgtnkASbxgtnkASTyAbR5AEg9gmweQxAPY5n80KlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+i8j+bJF4w27zIJPEik8QD2OYFk8S/lSReZLZ5kUniAWzzALZ5kdnmBZPEi8w2DyCJF5ltHkASD2CbB7DNA0jiP4htHkASDyCJF0wSL5htXjBJPIBtXmSSeADbPIBtXjDbPIAk/jtI4gWzzYvMNg8giReZbf7voHLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKv+r2OYBJPFvZZsXTBIPIIkXzDYvmCReMNs8gCQeQBIPYJsXTBIPYJv/IJJ4ANu8YLZ5AEk8gCT+rSTxn8M2DyCJB7DNv5VtHkASD2CbF0wS/1aSeADbvMgk8W8liQewzQsmiQewzYtMEv9WkvgPIon/xahcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMr/IbZ5AEm8YJJ4ANs8gG0eQBIvmCQewDYPYJv/IJJ4ANu8YJJ4ANv8W9nm38o2L5gkXjDbPIAk/kvY5gEk8W8liQewzQsmiQewzQsmiQewzQPY5gEk8YLZ5kVmmweQxAsmiX8rSTyAbV5kkngA2zyAJF4w27zIbPMAkvjfhMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqPzPZpsXmSQewDYvMkm8YLZ5AEk8gG1eMEk8gG0eQBIvMts8gCT+S0jiAWzzgkniAWzzIrPNA0jiAWzzAJL4t7LNA0jiBbPNA0jiAWzzAJJ4kUniRSaJF5kkHsA2LzLb/FvZ5gWTxAPY5gEk8QC2+c9hmxdMEg9gmweQxAPY5n8xKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+i8j+bJB7ANg9gm38rSTyAbV4wSTyAbV5ktnkASbxgtnnBJPEAtvkPIokHsM1/B0m8yGzzAJJ4ANs8gG1eZLZ5AEk8gG0eQBIPYJsXTBIPYJsHkMQDSOIFs82LTBL/OWzzAJJ4ANu8YJJ4kUniAWzzAJJ4kUniRSaJF5lt/jehctVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMq/29I4gFs819CEi8ySbxgtnkASTyAbV4wSfyXsM0DSOIBbPNvJYn/HLZ5wWzzAJJ4wSTxALZ5wSTxALZ5wSTxAJJ4wWzzAJJ4ANs8gCQewDYvmCQeQBIPYJsHkMQD2OYBJPGCSeIBbPMis80DSOIBbPOCSeIBbPOCSeIBbPO/CZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fIdv87yGJB7DNCyaJB7DNA0jiAWzzAJJ4ANs8gCQewDYvmCReZLZ5AEn8B7HNi0wS/yVs84JJ4gFs8wCSeADbPIAk/oPY5kUmiReZbR5AEg9gmxdMEg9gmxdMEg9gmweQxAPY5kUmiQewzb+VJB7ANg8gif8gtnkASTyAbf6/oHLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKv9f2eYFs80DSOJFJokXzDYPIIkHkMQD2OYFk8QLZpsHkMQLZpsHsM2/lSQewDYvMkn8B7HNA0jiBbPNA0jiASTxALZ5AEk8gG1eMEk8gCQewDb/VpJ4ANs8gG0eQBIPYJsHkMQD2OYFs80LJokHsM2LTBIPYJsHkMQD2OYBJPEis80DSOIFs80LJokHsM3/aFSuuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROV/Nkk8gG0eQBL/VpJ4wWzzb2WbfyvbPIAk/q0k8QC2eZFJ4gWzzQNI4j+Hbf5LSOIBbPMAkngASTyAbR5AEg9gmwewzQNI4gEk8SKzzQNI4gEk8YLZ5gEk8QC2eQBJPIBtXjBJvMgk8QC2eQBJvMgk8YLZ5gEk8YLZ5kUmif/FqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+Iyv9stvm3ss0LZpsHkMS/lSQewDYPIIkHsM0D2OY/h20eQBIvmG1eMNs8gCQewDYvMkk8gG0ewDYvmCReMEk8gG1eMNs8gCReMNs8gCReZJJ4ANs8gCQewDYPIIkHsM1/ENs8gCQeQBIPYJsHkMQD2OYBJPGfwzYPIIkHsM0DSOIBbPMAkvjfhMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PkG3+B5PEA9jmBZPEfwnbPIAkXmS2ecEk8YLZ5gEk8YLZ5kUmif8gtnkASTyAbV4wSbxgtnnBJPEis82LTBL/VrZ5AEn857DNv5Uk/q1s8wCS+LeyzQNI4n8A27xgkngA2/xvQuWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HyDb/e0jiAWzzgkniAWzzIpPEC2abB5DEA9jm30oSD2CbB5DEC2abfytJPIBtXmSS+A9im/8ckniR2eZFJokXzDYPIIkHsM2LTBIPYJsXTBL/VrZ5AEk8gG1eZJJ4wWzzAJJ4ANs8gCQewDYPIIkXzDYvMkm8yGzzAJJ4ANv8j0blqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1T+V7HNfxBJPIBtXmSSeADbvGCSeMFs84JJ4gFs8yKTxAPY5t9KEg9gmxfMNi8ySbzIJPEis80LZpsHkMQDSOIBbPOC2eYFk8SLTBIPYJt/K9u8YJJ4wSTxgkniAWzzAJJ4wWzzgtnmASTxALZ5AEn8W0niAWzzIrPNA0jiAWzzvwmVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1H530wSD2CbF5ltXmS2ecEk8gFs829lmxdMEi+YbR5AEv9WtnmRSeLfShIPYJv/ILZ5wWzzAJJ4AEm8yGzzALZ5AEm8YLZ5kUniAWzzgkniAWzzIpPEi8w2DyCJF0wSD2CbB7DNA0jiAWzzAJJ4kdnmRWabF5kkHsA2/6NRueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGyzf9gkngA27xgkvgvYZt/K0m8YLZ5AEm8YLZ5wSTxALZ5wSTxn8M2DyCJB7DNA0jiAWzzgkniAWzzgkniAWzzAJJ4ANs8gCQewDYPIIn/DrZ5wSTxALb5t5LEA9jmBZPEA9jmASTxALZ5AEk8gG0eQBIvmG0eQBL/QWzzIpPEA9jmfzQqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P0K2+d9DEv9BbPMAkngA2zyAJB7ANg8giReZbV4wSfxb2eYBJPEis80DSOIFs80DSOIBbPOCSeIFs80DSOIFs80DSOIFs80DSOIFs80LJokXzDYPIIkXmW1eMEk8gG1eZJJ4wWzzAJJ4kdnmP4gk/oPY5gWTxIvMNg8giQewzf9iVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X+EbPO/liQewDYvmCReZLZ5wSTxALZ5wSTxALb5t5LEA9jmBZPEv5VtHkASD2CbfytJvMhs84JJ4kVmm38rSTyAbV4wSbxgtnkASfxb2eYBJPEAtnkASbzIbPMAkngA2zyAJB7ANi8ySbzIbPMik8QD2ObfShIPYJsXTBIPYJv/0ahcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMr/KpL4t7LNi0wSLzJJPIBtHsA2DyCJB7DNA0jiAWzzn8M2L5gkXmSSeADbPIAkHsA2/1aSeADbvMgk8SKzzb+VbV4wSTyAbR5AEg9gmweQxANI4gFs8wCSeADb/FvZ5j+IJF4w2zyAJB5AEg9gmxeZJB7ANg8giQewzQsmiQewzQPY5n8TKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+i8j+bJB7ANv9WknjBbPMfRBIvmG1eMNs8gCQewDYvmCQewDYvmCQewDYPYJv/HJJ4ANs8gCQewDYPYJsXmSQewDYvmCT+rSTxIrPNi0wSD2CbfytJPIBtXmSSeADbPIBtHkASD2CbF5kk/q0k8QC2eZHZ5gEk8YLZ5gEk8QC2+d+EylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+Qbf7XksQD2OY/iCQewDb/HSTxgtnm30oSL5htXjBJPIBtXjBJPIBtHkASD2Cb/xySeMFs8wCSeMFs8yKTxIvMNg8giX8r2zyAJB7ANg8giRfMNg8giQewzQsmiQewzYtMEi+YbV4wSTyAbV4wSfznsM3/aFSuuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/hGzzf4Uk/oPY5gWTxAPY5gWTxAPY5gEk8W9lm/8gkniR2eYBJPEAtnnBJPEis80DSOIBbPOCSeLfyjYvMkk8gG3+rSTxALZ5kUniAWzzAJJ4wWzzAJJ4ANu8YJL4D2KbB5DEC2abF5kkHsA2L5gkHsA2L5gkHsA2/5tQueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGV/0Ns8wCSeMFs8wCSeABJPIBtHsA2L5gkHsA2/1a2eQBJvGCSeMFs84LZ5gWTxItMEg9gmwewzQsmif8gtvkvYZsHkMQLZpsHkMSLTBIPYJsXTBIvmG3+rSTxALZ5AEk8gG0eQBIPYJt/K0k8gG1eMNv8W0niRSaJB7DN/2hUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0TlfzZJPIBtHkAS/1aSeMFs8yKTxAPY5gWTxAtmmxfMNg8giRfMNg8giQewzQsmiX8r2zyAJB7ANg8giQewzQNI4gFs8wCSeADbPIAkHsA2L5gkHsA2DyCJB7DNC2abF0wSL5htXmSSeADb/AexzQNI4gFs8wCS+LeSxIvMNg8giReZJF5ktnkASbxgtnkASfxvQuWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVP5XkcQD2OYBJPEAtnmRSeI/iCQewDYPYJv/HLZ5kUniv4MkHsA2L5htXjDbPIAkHsA2DyCJF5kkXjBJPIBtXmS2ecEk8Z9DEg9gmweQxAtmm/8gtnnBJPFvJYkHsM0LZpsXTBIvmG1eMNv8b0Llqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1T+Z7PNA0jiRSaJB7DNA0jiRSaJB7DNi0wSD2Cb/yC2+beyzQNI4gWzzYtMEv85JPFvZZv/IJJ4wSTxALZ5AEk8gG3+rWzzgkniRWabF5kkXjDbvGCSeADbPIBtXmS2eQBJvGC2ecEk8R9EEg9gm//RqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+Iyv9skniR2eZFZpv/ILZ5AEn8W0niBbPNi0wSL5gkHsA2DyCJF0wSD2CbfytJvGC2ecFs84JJ4gFs84JJ4gWzzQsmiQewzQtmmxeZbR5AEi+YJB7ANg8giX8rSbxgtnnBJPGCSeIBbPMAknjBbPMAtnnBJPEAtnkA27zIJPEAtnkA2/xvQuWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HyDb/e0jiAWzzgkniRWabB5DEC2abB5DEC2abF0wSD2CbB5DEC2abB5DEA9jmASTxALb5DyKJB7DNCyaJF8w2DyCJB7DNA0jiBbPNi0wSL5htHkASL5htHkAS/0Fs8yKTxL+VbV4wSfwHsc0DSOIFs80DSOI/h20eQBIPYJsHkMQLZpv/0ahcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMr/IZJ4ANu8yCTxALb5t7LNA0jiAWzzX0ISD2CbB5DEA9jmASTxgtnmAWzzAJJ4ANs8gG0eQBL/89jm30oSD2CbF0wSL5htXjBJvGC2ecEk8W9lmxdMEg9gmweQxAtmm38r27zIJPEis80LZpsHkMT/JlSuuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROX/ENu8YJJ4wWzzAJJ4ANu8yCTxALZ5AEm8yGzzAJJ4wWzzAJJ4AEm8YJJ4wWzzIrPNfw5JPIBtHkASDyCJB7DNA0jiAWzzAJL4DyKJF5ltHkASLzLbPIAkXjDbvGCS+LeyzQNI4gFs84JJ4gFs84LZ5kUmiQewzQNI4t9KEv+LUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlf/NJPEAtnkASTyAbV4wSTyAbV4wSTyAbV4wSbxgtnnBJPGCSeIBbPMis80DSOIBbPMAkngA27xgkngA2zyAJB7ANg8giRfMNg8giQewzQsmiQewzYvMNi+YJB7ANg8giQewzYvMNi8ySbxgtnkASTyAbR7ANg8giQewzYvMNi+YJB7ANg8giRfMNi+YJP5zSOIBbPMAkvjfhMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqPzPJokHsM0DSOIFs80DSOIFs80LJol/K9s8gCQeQBIvMts8gCQeQBL/QSTxALb5L2GbB5DEfxDbvGCSeADb/AexzQNI4gFs8wCSeADbPIAkXmS2eZFJ4gFs84JJ4kVmmxfMNg8giQewzQsmiQewzYtMEi8ySTyAbf7voHLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKv+b2eYBJPGC2eYFk8QD2ObfShIPYJsXzDYvmCReMNs8gCReZJJ4ANs8gCT+g0jiBZPEA9jmAWzzgtnmASTxIrPNi0wSD2CbF5kk/nPY5gWTxH8Q27zIJPEik8QLJokXmSReMNs8gCT+c9jmfxMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P0K2+d9DEi8y27xgknjBbPMAkniR2eZFJokHsM0DSOJFZpsHkMQD2OZFJon/ILZ5wSTxgtnm30oSD2CbF0wSL5htHkASL5ht/q0k8QC2eZFJ4gFs8wCSeMFs84JJ4gFs8wCSeADbvMgk8QC2eQBJPIBtHkASD2CbB5DEi8w2DyCJB7DNA0jiAWzzAJJ4ANv8j0blqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1T+N7PNi0wSD2CbB5DEi8w2/1aSeJHZ5gEk8SKzzQNI4gFs8wCSeADbPIAkHsA2L5gkXjBJPIBtHkASDyCJB7DNA0jiAWzzALZ5AEk8gG1eMNs8gCReMNu8YJJ4kdnmASTxALb5zyGJF8w2DyCJF0wSL5htHsA2L5htXjDb/FvZ5gWzzQNI4gWTxP9iVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X+EbPO/hyReZLZ5wSTxALb5LyGJB7DNi0wSD2CbB5DEC2abB5DEfwnbPIAkXmS2eQBJPIBtHkASD2CbB5DEC2abF5kkXmS2eQBJ/AexzX8OSTyAbV4wSTyAbR5AEi+YbV5kkngA2zyAJP5z2OYBJPEAtnkASTyAbf5Ho3LVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jZJurnockHsA2/yUk8QC2eZFJ4j+IbV5kkngA2zyAJF4w2zyAJB7ANg8giRfMNi+YJP6tbPOCSeIBbPMAknjBbPMik8QD2OZFJokHsM1/Dkk8gG0eQBIvmG1eZJJ4kdnmRSaJF5lt/hejctVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMq/7NJ4r+EbR7ANg8giQewzQsmiQewzQNI4gWzzYtMEg9gmweQxAPY5gEk8SKTxAPY5gWTxAtmmxfMNi+YbR5AEg8giRfMNi8ySTyAJF4w2/wHkcQD2OZFJol/K0k8gG1eMEk8gG0ewDYPIIkHsM0DSOIBJPEis80DSOJFJokHsM2/lSQewDb/m1C56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EbLN/2CSeADb/AeRxAPY5kUmiQewzQNI4t/KNg8giQewzX8QSbxgtnmRSeK/g20eQBIvMtv855DEi8w2LzJJPIBtXjBJvGC2eQBJvGC2eZFJ4j+Ibf6tJPEAtnmRSeIBbPOCSeIFs83/aFSuuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROV/M0m8yGzzIpPEA9jmBZPEC2abB5DEi8w2LzJJvMhs8wCSeABJ/HewzQsmiQeQxAPY5gWTxAsmiReZbf6DSOLfShIvmG3+rWzzAJJ4ANu8YLZ5AEk8gG0eQBIPYJsXmSQewDYvmCT+rSTxALZ5ANs8gCT+N6Fy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXvQgk8SKzzQtmmweQxANI4kVmmxfMNi8y2zyAJF4w2zyAJB7ANi+YJP6tbPMAkngASbxgtnkASTyAbR5AEv9BbPMAkvi3ss0DSOIBbPMAkniR2eZFJol/K0k8gG0eQBIPYJsHkMR/ENv8W0niAWzzALb534TKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hc9fzY5gEk8YLZ5gWTxAPY5gWzzQNI4gWTxAsmiRfMNg8giQewzQsmiX8r27zIJPEAtnkA2zyAJF4wSfxb2eYBJPFvZZv/ErZ5AEk8gG0eQBL/Vrb5D2KbF8w2/0Ek8QC2eQBJvGC2eQBJvGC2+R+NylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+o/G9mm/8ckngA27zIJPGCSeIBbPMAkvgvIYkXTBIPYJsHsM0LJokHsM0LJokHsM0LJokHsM0LZpsXTBIPIIl/K9u8YJJ4ANs8gCReZLZ5wSTxALZ5ANu8YLb5t5LEA9jmRSaJF8w2L5gkHsA2L5htHkASLzLbPIAkHsA2/4tRueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGV/1Uk8T+PJB7ANi+YJB5AEg9gmweQxAPY5kUmif8ckngA2zyAbV4wSbzIbPOfwzYPIIkXTBIPYJv/ILZ5AEm8yGzzH0QS/0Ek8YLZ5gWzzYvMNg8giQewzQNI4kVmmweQxAPY5v8OKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j9Ctrnqqquuuur/HSpXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R1Suuuqqq676/4jKVVddddVV/x9Rueqqq6666v8jKlddddVVV/1/ROWqq6666qr/j6hcddVVV131/xGVq6666qqr/j+ictVVV1111f9HVK666qqrrvr/iMpVV1111VX/H1G56qqrrrrq/yMqV1111VVX/X9E5aqrrrrqqv+PqFx11VVXXfX/EZWrrrrqqqv+P6Jy1VVXXXXV/0dUrrrqqquu+v+IylVXXXXVVf8fUbnqqquuuur/IypXXXXVVVf9f0Tlqquuuuqq/4+oXHXVVVdd9f8Rlauuuuqqq/4/onLVVVddddX/R/wjpy3K7GpCg0QAAAAASUVORK5CYII=",
    "ipfs": {
      "url": "https://blush-selective-earwig-920.mypinata.cloud/ipfs/bafkreih4rrrtpqszm66srlxnbesbwt2sxks2hpqaoovrmgz4vwsvtdtfta",
      "IpfsHash": "bafkreih4rrrtpqszm66srlxnbesbwt2sxks2hpqaoovrmgz4vwsvtdtfta",
      "PinSize": 14231,
      "Timestamp": "2025-10-15T15:12:56.001Z",
      "ID": "4b3c4fcb-7c17-4465-b592-4386b78dbaab",
      "Name": "613375a1eab2fe08527f81e2_random_98138.json",
      "NumberOfFiles": 1,
      "MimeType": "application/json",
      "GroupId": "861b93d7-9795-461d-b479-31f751d6869e",
      "pinned": true,
      "web3": true,
      "name": "613375a1eab2fe08527f81e2_random_98138.json",
      "metadata": [
        "a",
        "b"
      ]
    }
  },
  "credits": {
    "amount": -0.84,
    "status": "approved",
    "category": "usage",
    "client": "613375a1eab2fe08527f81e2",
    "superAdmin": null,
    "expensesGroup": "613375a1eab2fe08527f81e2_random_98138",
    "product": "humanAuthn",
    "transaction": null,
    "expiresAt": null,
    "isExpired": false,
    "referenceCredit": null,
    "_id": "68efb9f84e861cf25e041171",
    "updatedAt": "2025-10-15T15:12:56.443Z",
    "createdAt": "2025-10-15T15:12:56.443Z",
    "__v": 0
  }
}

401

{
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

403

{
  "message": "Access Forbidden",
  "code": "FORBIDDEN"
}

409

{
  "message": "\"faceBase64\" is required",
  "code": "MissingParameter"
}

500

{
  "message": "internal_error",
  "code": "ERROR"
}

Notes

• The humanIDQR field contains a base64-encoded PNG QR code image
• The QR code can be displayed directly in applications or saved as an image file
• IPFS data includes metadata about the stored HumanID and public data keys
• Credits are deducted for HumanID creation (typically 0.84 credits)
• The identifier must be alphanumeric only (no spaces or special characters)
• publicData and metadata must contain only string key-value pairs
• QR codes are ideal for offline sharing and mobile applications
• The QR code contains the same encrypted HumanData as the regular Encrypt HumanID endpoint