API Documentation

Complete reference for the unfamiliar.id REST API. Authenticate users, verify documents, and match faces.

Getting Started

The unfamiliar.id API uses REST conventions with JSON request and response bodies. All API requests must be made over HTTPS.

Base URL: https://api.unfamiliar.id/v1

Authenticate requests using Bearer tokens in the Authorization header.

curl -X POST https://api.unfamiliar.id/v1/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

POST/v1/verify

Submit documents for verification

POST/v1/verify/face-match

Compare selfie to document photo

GET/v1/verify/{id}

Get verification status and results

POST/v1/documents/parse

Extract data from document images

POST/v1/documents/authenticate

Check document authenticity

GET/v1/webhooks

List configured webhooks

Receive real-time notifications when verification events occur.

{
  "event": "verification.completed",
  "data": {
    "id": "ver_123abc",
    "status": "approved",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Get your API key and start verifying identities in minutes.