Quickstart

Choose one authentication method, then replace the credential placeholders, transaction ID, and image with values for your integration.

Basic Authentication

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

Bearer HMAC Authentication

Code
curl -X POST https://stg-b2b-api.privy.id/api/v1/inspect \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Timestamp: <TIMESTAMP>' \
  -H 'Signature: <SIGNATURE>' \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_id": "id-forgery-001",
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "channel": "web"
  }'

A successful request returns HTTP 200:

Code
{
  "code": 200,
  "status": "success",
  "client_transaction_id": "id-forgery-001",
  "result": {
    "forged": false
  },
  "balance": 100,
  "transaction_id": "019c1234-5678-7abc-8def-0123456789ab",
  "message": "inspect successful"
}