Quickstart

Replace the sample credentials, merchant key, transaction ID, and images with values for your integration.

Code
curl -X POST https://stg-b2b-api.privy.id/api/v1/face-compare \
  -H 'Authorization: Basic <BASE64_USERNAME_PASSWORD>' \
  -H 'Merchant-Key: <MERCHANT_KEY>' \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_id": "face-compare-001",
    "face1": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "face2": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
  }'

A successful 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"
}

The score is illustrative. Privy does not define a public pass threshold for this endpoint.