Copy page

v1

Comparison Results

A successfully processed request returns HTTP 200.

Code
{
  "code": 200,
  "status": "success",
  "client_transaction_id": "face-compare-001",
  "data": {
    "score": 98.75
  },
  "balance": 100,
  "transaction_id": "019c1234-5678-7abc-8def-0123456789ab",
  "message": "face compare successful"
}

Field	Type	Description
code	integer	HTTP-compatible response code.
status	string	success when comparison completes.
client_transaction_id	string	The transaction_id supplied in the request.
data.score	number	Numeric face-similarity score returned by Privy. No public pass threshold is defined.
balance	integer	Remaining service balance. Postpaid integrations return 100.
transaction_id	string	Privy's transaction identifier.
message	string	face compare successful for a successful request.