Passwordless - JAAK

General description

The Passwordless module JAAK provides biometric facial authentication without passwords through a API That's complete.

Version of the document: 1.0 | Last Updated: November 2024 | Version API: v1

Authentication

All endpoints require authentication by API Key using head ApiKeyAuth.

URLs Base

User Management

1. List Users

GET /api/v1/passwordless/client

• Supports filtering by status, name, external ID and date ranges
• Includes pages with configurable boundaries

2. Obtain User Details

GET /api/v1/passwordless/client/:id

• Full user profile with images and metadata

3. Updating User

PUT /api/v1/passwordless/client/:id

• Modify name and status and accept geolocalisation leaders

4. Remove User

DELETE /api/v1/passwordless/client/:id

• Permanent (irreversible) disposal

Enrollment (Biometric Record)

Enrollment by Video

POST /api/v1/passwordless/client/enroll

• Accept video base64 (2-5 seconds, minimum 720p)
• Retort user profile with event monitoring

Enrollment by Image

POST /api/v1/passwordless/client/face-enroll

• Requires JPG / PNG format, minimum resolution 640x480
• The face should be front, focused and without obstructions

Identity Verification

Video Verification

POST /api/v1/passwordless/client/verify

Image Check

POST /api/v1/passwordless/client/face-verify

Both search existing searches and confirm matching.

Facial Search

Search by Image

POST /api/v1/passwordless/client/facial

• Accept parameter rankingTop for number of results
• Retiro coincidences ordered by distance of similarity

Search by Vector

POST /api/v1/passwordless/client/faces

• Use pre-computed vector (128-512 dimensions)
• Allows quick batch processing

Events and Audit

List Events

GET /api/v1/passwordless/event

• Filtering by action, status, processing time, date ranges

Event details

GET /api/v1/passwordless/event/:id

• Full audit track with status at resource level

Statistics

• Time Requests count - Granular analysis (minute / hour / day)
• processing time analysis - Average, fashion and distribution

Best Practices

Security

• Never explain API front code keys
• Rotate regularly
• Always use HTTPS

Leaders

• Include Request-Id single (UUID v4)
• Provide geolocalisation as available

Media quality

• Ensure uniform light
• Fitted face
• Respect minimum resolutions indicated

Errors Management

• Implement Reattempt logic with exponential backoff
• Record event IDs for problem solving

Response structure

The standard responses include: eventId, requestId, processTime (milliseconds) and user objects / event.

HTTP code

• 200 - Success
• 400 - Wrong request
• 401 - Unauthorized
• 404 - Not found
• 500 - Server error

Cases of Common Use

• Biometric login systems
• Physical Access Control
• Monitoring of assistance
• Duplicate detection and fraud prevention