Overview

Face Compare API v1 compares two submitted face images and returns a numeric similarity score. The score can support a digital certificate issuance workflow, but this API does not decide whether a certificate should be issued and does not issue a certificate.

Endpoint

POST /api/v1/face-compare

How it works

1. Send a unique transaction_id and two Base64-encoded face images.
2. Privy validates the credentials, transaction ID, and image files.
3. Privy compares the two faces and returns a numeric score.
4. Use client_transaction_id and transaction_id to correlate the result with your request and Privy's processing record.

The API does not define a public pass threshold. Follow the score interpretation agreed for your integration.

Next steps

• Follow the Quickstart.
• Review Authentication.
• Prepare both images according to Request Fields.