Developer Documentation

Build with biometric identity
in minutes.

The Aye Verify API gives your platform face recognition, voice biometrics, and behavioral intelligence — in a single REST call. Full API reference is available to clients with an API key.

Full API reference is gated.

The complete endpoint documentation — including request schemas, response formats, and code examples — is available exclusively to clients with an active API key.

Request an API Key View Pricing →
What You Can Build

One API. Three biometric layers.

Aye Verify handles the biometric infrastructure — you get a simple, clean API that returns trust decisions. Integrate in hours, not weeks.

Face Verification

Enroll and verify users by face. Liveness detection included. Under 2 seconds.

Voice Biometrics

Voiceprint enrollment and continuous cadence matching. Powers the IVY recovery flow.

Behavioral Intelligence

Passive per-user and per-device baselines. Continuous anomaly detection in every session.

Authentication

Bearer token, one header.

Every request to the Aye Verify API requires your API key in the Authorization header.

All requests 
# Include this header in every API call
Authorization: Bearer ak_live_your_api_key_here

# Example
curl -X POST https://api.aye-verify.com/face/verify/usr_abc \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{"image": "<base64_frame>"}'
How It Works

The verification flow.

Aye Verify follows a simple enroll → verify → monitor pattern. Full implementation details are in the gated documentation.

1

Enroll

Register a user's face, voice, and behavioral baseline. Call once per user — during onboarding.

2

Verify at login

On each login, send a face frame. Receive a match score, liveness result, and risk score in under 2 seconds.

3

Monitor the session

Send behavioral ticks throughout the session. The risk engine flags anomalies in real time — no polling needed.

4

Recover via IVY

If a user is locked out, IVY — our AI voice agent — handles re-verification and recovery end-to-end.

API Reference

Full endpoint documentation — gated.

Below is a preview. Request an API key to unlock the full reference including request schemas, response examples, error codes, and SDK integration guides.

POST /face/enroll/{user_id} Enroll face biometric
POST /face/verify/{user_id} Verify face + liveness
POST /session/create Start a monitored session
POST /voice/enroll/{user_id} Enroll voice biometric
POST /behavioral/analyze Analyze behavioral tick
GET /risk/status/{user_id} Get real-time risk status
POST /passkey/register/start Begin passkey registration
POST /recovery/start Initiate IVY recovery
Full reference requires an API key

20+ additional endpoints including voice biometrics, behavioral analysis, passkeys, risk engine, and IVY recovery.

Request API Key →

Ready to integrate?

Request an API key to get instant access to the full documentation, code examples, and our JavaScript SDK.

Request API Key Back to Home