Documentation

Everything you need to integrate BFPS facial recognition into your application.

Get StartedAPI Reference

Getting Started

Learn the basics and make your first API call in minutes.

API Reference

Complete reference for all endpoints, parameters, and responses.

SDKs & Libraries

Official SDKs for Python, Node.js, Go, and more.

Authentication

Learn how to authenticate and manage API keys.

Getting Started

Follow these steps to make your first API call.

1

Get your API key

Sign up for a free account and generate your API key from the dashboard. Your key will look like: bfps_live_xxxxxxxxxxxx

2

Install the SDK

pip install bfpsPython
npm install @bfps/sdkNode.js
3

Make your first request

import bfps

client = bfps.Client(api_key="YOUR_API_KEY")

result = client.verify(
    probe="face1.jpg",
    reference="face2.jpg"
)

print(f"Match: {result.match}")
print(f"Similarity: {result.similarity}")

API Reference

Core endpoints for facial recognition operations.

POST/v1/verify

Compare two faces and get similarity score

POST/v1/detect

Detect faces in an image with bounding boxes

POST/v1/enroll

Enroll a face template for a customer

POST/v1/identify

Search for matching faces in enrolled database

POST/v1/liveness

Check if image contains a live person

Full API documentation with request/response examples coming soon.

Request Early Access

SDKs & Libraries

Official SDKs for popular programming languages.

Python

v1.2.0
pip install bfps

Node.js

v1.1.5
npm install @bfps/sdk

Go

v1.0.3
go get github.com/bfps/bfps-go

Java

v1.0.1
Maven: com.bfps:bfps-java