Biometric Auth Service - API Contract

GET /api/v1/auth/biometric/api/v1/auth/biometric/availability

Check if biometric authentication is available on device

Public

Response Example

{
  "available": true,
  "enrolled": true,
  "reason": null
}

GET /api/v1/auth/biometric/api/v1/auth/biometric/types

List supported biometric types on device

Public

Response Example

{
  "data": [
    {
      "type": "fingerprint",
      "label": "Fingerprint"
    },
    {
      "type": "face",
      "label": "Face ID"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}

POST /api/v1/auth/biometric/api/v1/auth/biometric/authenticate

Trigger biometric authentication prompt

Public

Request Example

{
  "localized_reason": "Logg inn med biometri for å bekrefte din identitet"
}

Response Example

{
  "authenticated": true,
  "biometric_type_used": "fingerprint",
  "authenticated_at": "2026-03-26T10:15:00Z"
}

POST /api/v1/auth/biometric/api/v1/auth/biometric/enroll

Enroll biometric authentication for current user

Public

Request Example

{
  "user_id": "usr_7f3a1c9d"
}

Response Example

{
  "user_id": "usr_7f3a1c9d",
  "enrolled": true,
  "enrolled_at": "2026-03-26T10:15:30Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}