Local Auth Integration - API Contract

GET /api/v1/local-auth/api/v1/local-auth

Public

Response Example

{
  "data": [
    {
      "id": "lauth_A1",
      "device_id": "dev_iphone15pro",
      "biometric_type": "face_id",
      "result": "success",
      "error_code": null,
      "attempted_at": "2026-03-26T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 47
  }
}

GET /api/v1/local-auth/api/v1/local-auth/:id

Public

Response Example

{
  "id": "lauth_A1",
  "device_id": "dev_iphone15pro",
  "biometric_type": "face_id",
  "result": "success",
  "error_code": null,
  "attempted_at": "2026-03-26T08:00:00Z"
}

GET /api/v1/local-auth/api/v1/local-auth/device-support

Public

Response Example

{
  "is_supported": true,
  "device_id": "dev_iphone15pro",
  "platform": "ios",
  "os_version": "17.4"
}

GET /api/v1/local-auth/api/v1/local-auth/available-biometrics

Public

Response Example

{
  "available_biometrics": [
    "face_id"
  ],
  "is_device_supported": true,
  "enrolled": true
}

POST /api/v1/local-auth/api/v1/local-auth/authenticate

Public

Request Example

{
  "localized_reason": "Authenticate to access your account",
  "use_error_dialogs": true,
  "sensitive_transaction": false
}

Response Example

{
  "id": "lauth_B2",
  "result": "success",
  "biometric_type": "face_id",
  "localized_reason": "Authenticate to access your account",
  "error_code": null,
  "attempted_at": "2026-03-26T09:15:30Z",
  "created_at": "2026-03-26T09:15:30Z"
}

PUT /api/v1/local-auth/api/v1/local-auth/:id

Public

Request Example

{
  "result": "failed",
  "error_code": "LAErrorAuthenticationFailed"
}

Response Example

{
  "id": "lauth_A1",
  "device_id": "dev_iphone15pro",
  "biometric_type": "face_id",
  "result": "failed",
  "error_code": "LAErrorAuthenticationFailed",
  "attempted_at": "2026-03-26T08:00:00Z"
}

DELETE /api/v1/local-auth/api/v1/local-auth/authentication

Public

Response Example

{
  "cancelled": true,
  "message": "Local authentication cancelled"
}

DELETE /api/v1/local-auth/api/v1/local-auth/:id

Public

Response Example

{
  "deleted": true,
  "id": "lauth_A1"
}

Additional Metadata

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