biofrq

Overview

BioFRQ is a face-recognition service exposed through a single public endpoint: POST /v1/face/execute. Every request carries an action field that selects one of nine verbs:

  • biofrq.detect
  • biofrq.liveness
  • biofrq.verify
  • biofrq.identify
  • biofrq.enroll
  • biofrq.update
  • biofrq.deleteSubject
  • biofrq.analyze
  • biofrq.attributes

The response carries the per-action payload plus a requestId for correlation with the dashboard's RequestLog.

The service shape

Your app ──► POST /v1/face/execute ──► BioFRQ
              X-Api-Key: bfq_live_…
              { action: "biofrq.identify", params: { … } }

The same endpoint serves every action. The verb is in the JSON body, not the URL path. Envelope-level revisions are reserved for the X-Api-Version header; today the only accepted value is 1.

Authentication

Every request carries an X-Api-Key header. Mint a key from the API Keys page in this dashboard, then send the full string on every request:

X-Api-Key: bfq_live_…

Treat the key as a password — anyone with it can call the API on your behalf.

Cost model

Each action has a price expressed in micro-credits (1 USD = 1,000,000 micro-credits). Billing fires only when the action runs successfully; requests rejected at the rate-limit gate, the dedup gate, or for input-quality reasons (no face detected, payload too large) are not billed. Spend drains the project budget, not the wallet directly. The full price table lives under Billing → How credits work.

Next steps