menu_bookAPI reference: Create HumanIDexpand_more
POST /v2/human-id/encrypt
Bind public identity data and a face biometric into an encrypted ZelfProof stored on IPFS. Only the matching live face can decrypt it.
| Param | Req | Description |
|---|---|---|
| publicData | Yes | Object with string values |
| faceBase64 | Yes | Base64 face image |
| metadata | Yes | Object with string values |
| os | Yes | DESKTOP / IOS / ANDROID |
| identifier | Yes | Alphanumeric person identifier |
| requireLiveness | Yes | Require liveness on decrypt |
| tolerance | No | Liveness strictness when live face is required: REGULAR / SOFT / HARDENED (also REGULAR_HARD, REGULAR_SOFT upstream) |
| password | No | Optional encryption password |
Create HumanID
Bind identity data + face into an encrypted ZelfProof on IPFS.