🔍
Purchase the full subscription package now and enjoy a 40% discount, along with free updates for future editions.
AS ISO/IEC 19784.1:2019
$177.61
Information technology — Biometric application programming interface, Part 1: BioAPI specification
The objective of this Standard is to define the Application Programming Interface (API) and Service Provider Interface (SPI) for standard interfaces within a biometric system that support the provision of that biometric system using components from multiple vendors. It provides interworking between such components through adherence to this and to other International Standards.
Table of contents
Header
About this publication
Preface
Foreword
Introduction
1 Scope
2 Normative references
3 Terms and definitions
4 Symbols and abbreviated terms
5 Conformance
5.1
5.2
6 The BioAPI architecture
6.1 The full BioAPI API/SPI Architectural Model
6.1.1
6.1.2
6.1.3
6.1.4
6.1.5
6.1.6
6.1.7
6.1.8
6.2 The framework-free BioAPI Architectural Model
6.2.1
6.2.2
6.2.3
6.3 The BioAPI BSP Architectural Model
6.3.1
6.3.2
6.3.3
6.3.4
6.3.5
6.3.6
6.3.7
6.3.8
6.3.9
6.4 The component registry
6.4.1
6.4.2
6.4.3
6.4.4
6.4.5
6.4.6
6.5 BSP and BFP Installation and De-installation
6.5.1
6.5.2
6.5.3
6.5.4
6.5.5
6.5.6
6.6 BSP Load and BioAPI Unit Attachment
6.6.1
6.6.2
6.6.3
6.6.4
6.6.5
6.6.6
6.6.7
6.6.8
6.7 Controlling BioAPI Units
6.7.1
6.7.2
6.8 BIR Structure and Handling
6.8.1 BIR Structure
6.8.2 BIR Data Handling
7 BioAPI types and macros
7.1 BioAPI
7.2 BioAPI_ACBio_PARAMETERS (BioAPI 2.2)
7.2.1
7.2.2
7.3 BioAPI_ASN1_BIR (BioAPI 2.2)
7.4 BioAPI_ASN1_ENCODED (BioAPI 2.2)
7.5 BioAPI_BFP_LIST_ELEMENT
7.5.1
7.5.2
7.6 BioAPI_BFP_SCHEMA
7.6.1
7.6.2
7.7 BioAPI_BIR
7.7.1
7.7.2
7.8 BioAPI_BIR_ARRAY_POPULATION
7.9 BioAPI_BIR_BIOMETRIC_DATA_FORMAT
7.10 BioAPI_BIR_BIOMETRIC_PRODUCT_ID
7.11 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.0)
7.12 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.1)
7.13 BioAPI_BIR_DATA_TYPE
7.13.1
7.13.2
7.13.3
7.13.4
7.14 BioAPI_BIR_HANDLE
7.15 BioAPI_BIR_HEADER
7.16 BioAPI_BIR_PURPOSE
7.16.1
7.16.2
7.16.3
7.17 BioAPI_BIR_SECURITY_BLOCK_FORMAT
7.18 BioAPI_BIR_SUBTYPE (BioAPI 2.0)
7.18.1
7.18.2
7.18.3
7.19 BioAPI_BIR_SUBTYPE (BioAPI 2.1)
7.19.1
7.19.2
7.19.3
7.19.4
7.19.5
7.19.6
7.19.7
7.19.8
7.19.9
7.19.10
7.20 BioAPI_BIR_SUBTYPE_MASK (BioAPI 2.1)
7.21 BioAPI_BOOL
7.22 BioAPI_BSP_SCHEMA (BioAPI 2.0)
7.22.1
7.22.2
7.22.3
7.23 BioAPI_BSP_SCHEMA (BioAPI 2.1)
7.23.1
7.23.2
7.23.3
7.23.4
7.24 BioAPI_CANDIDATE
7.25 BioAPI_CATEGORY
7.26 BioAPI_DATA
7.26.1
7.26.2
7.27 BioAPI_DATE
7.28 BioAPI_DB_ACCESS_TYPE
7.29 BioAPI_DB_MARKER_HANDLE
7.30 BioAPI_DB_HANDLE
7.31 BioAPI_DBBIR_ID
7.32 BioAPI_DTG
7.33 BioAPI_ENCRYPTION_ALG (BioAPI 2.2)
7.34 BioAPI_ENCRYPTION_INFO (BioAPI 2.2)
7.34.1
7.34.2
7.35 BioAPI_ERROR_INFO (BioAPI 2.1)
7.36 BioAPI_EVENT
7.37 BioAPI_EVENT_MASK
7.38 BioAPI_EventHandler
7.38.1
7.38.2
7.39 BioAPI_FMR
7.40 BioAPI_FRAMEWORK_SCHEMA
7.40.1
7.40.2
7.40.3
7.41 BioAPI_GUI_BITMAP (BioAPI 2.0)
7.41.1
7.41.2
7.42 BioAPI_GUI_BITMAP (BioAPI 2.1)
7.42.1
7.42.2
7.42.3
7.43 BioAPI_GUI_BITMAP_ARRAY (BioAPI 2.1)
7.44 BioAPI_GUI_ENROLL_TYPE (BioAPI 2.1)
7.45 BioAPI_GUI_EVENT_SUBSCRIPTION (BioAPI 2.1)
7.46 BioAPI_GUI_MESSAGE (BioAPI 2.0)
7.47 BioAPI_GUI_MOMENT (BioAPI 2.1)
7.48 BioAPI_GUI_OPERATION (BioAPI 2.1)
7.49 BioAPI_GUI_PROGRESS (BioAPI 2.0)
7.50 BioAPI_GUI_PROGRESS (BioAPI 2.1)
7.51 BioAPI_GUI_RESPONSE (BioAPI 2.0)
7.52 BioAPI_GUI_RESPONSE (BioAPI 2.1)
7.53 BioAPI_GUI_STATE (BioAPI 2.0)
7.54 BioAPI_GUI_STATE_CALLBACK (BioAPI 2.0)
7.54.1
7.54.2
7.54.3
7.55 BioAPI_GUI_STREAMING_CALLBACK (BioAPI 2.0)
7.55.1
7.55.2
7.55.3
7.56 BioAPI_GUI_SUBOPERATION (BioAPI 2.1)
7.57 BioAPI_HANDLE
7.58 BioAPI_HASH_ALG (BioAPI 2.2)
7.59 BioAPI_IDENTIFY_POPULATION
7.60 BioAPI_IDENTIFY_POPULATION_TYPE
7.61 BioAPI_INDICATOR_STATUS
7.62 BioAPI_INPUT_BIR
7.63 BioAPI_INPUT_BIR_FORM
7.64 BioAPI_INSTALL_ACTION
7.65 BioAPI_INSTALL_ERROR
7.66 BioAPI_KEY_INFO (BioAPI 2.2)
7.66.1
7.66.2
7.67 BioAPI_KEY_TRANSPORT (BioAPI 2.2)
7.67.1
7.67.2
7.68 BioAPI_MAC_ALG (BioAPI 2.2)
7.69 BioAPI_MAC_INFO (BioAPI 2.2)
7.69.1
7.69.2
7.70 BioAPI_OPERATIONS_MASK
7.71 BioAPI_OPTIONS_MASK
7.72 BioAPI_POWER_MODE
7.73 BioAPI_QUALITY
7.73.1
7.73.2
7.73.3
7.73.4
7.73.5
7.74 BioAPI_RETURN
7.74.1
7.74.2
7.75 BioAPI_SECURITY_OPTIONS_MASK (BioAPI 2.2)
7.76 BioAPI_SECURITY_PROFILE (BioAPI 2.2)
7.76.1
7.76.2
7.77 BioAPI_DIGITAL_SIGNATURE_ALG (BioAPI 2.2)
7.78 BioAPI_STRING
7.78.1
7.78.2
7.79 BioAPI_TIME
7.80 BioAPI_UNIT_ID
7.81 BioAPI_UNIT_LIST_ELEMENT
7.81.1
7.81.2
7.82 BioAPI_UNIT_SCHEMA
7.82.1
7.82.2
7.83 BioAPI_UNIT_SCHEMA (BioAPI 2.2)
7.83.1
7.83.2
7.84 BioAPI_UUID
7.85 BioAPI_VERSION
7.86 GUI Events
7.86.1 BioAPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1)
7.86.1.1 Callback function
7.86.1.2 Description
7.86.1.3 Parameters
7.86.1.4 Return Value
7.86.1.5 Errors
7.86.2 BioAPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1)
7.86.2.1 Callback function
7.86.2.2 Description
7.86.2.3 Parameters
7.86.2.4 Return Value
7.86.2.5 Errors
7.86.3 BioAPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1)
7.86.3.1 Callback function
7.86.3.2 Description
7.86.3.3 Parameters
7.86.3.4 Return Value
7.86.3.5 Errors
8 BioAPI functions
8.1 Component Management Functions
8.1.1 BioAPI_Init
8.1.1.1 Description
8.1.1.2 Parameters
8.1.1.3 Return Value
8.1.1.4 Errors
8.1.2 BioAPI_Terminate
8.1.2.1 Description
8.1.2.2 Parameters
8.1.2.3 Return Value
8.1.2.4 Errors
8.1.3 BioAPI_GetFrameworkInfo
8.1.3.1 Description
8.1.3.2 Parameters
8.1.3.3 Return Value
8.1.3.4 Errors
8.1.4 BioAPI_EnumBSPs
8.1.4.1 Description
8.1.4.2 Parameters
8.1.4.3 Return Value
8.1.4.4 Errors
8.1.5 BioAPI_BSPLoad
8.1.5.1 Description
8.1.5.2 Parameters
8.1.5.3 Return Value
8.1.5.4 Errors
8.1.6 BioAPI_BSPUnload
8.1.6.1 Description
8.1.6.2 Parameters
8.1.6.3 Return Value
8.1.6.4 Errors
8.1.7 BioAPI_BSPAttach
8.1.7.1 Description
8.1.7.2 Parameters
8.1.7.3 Return Value
8.1.7.4 Errors
8.1.8 BioAPI_BSPAttachSecure (BioAPI 2.2)
8.1.8.1 Description
8.1.8.2 Parameters
8.1.8.3 Return Value
8.1.8.4 Errors
8.1.9 BioAPI_BSPDetach
8.1.9.1 Description
8.1.9.2 Parameters
8.1.9.3 Return Value
8.1.9.4 Errors
8.1.10 BioAPI_QueryUnits
8.1.10.1 Description
8.1.10.2 Parameters
8.1.10.3 Return Value
8.1.10.4 Errors
8.1.11 BioAPI_EnumBFPs
8.1.11.1 Description
8.1.11.2 Parameters
8.1.11.3 Return Value
8.1.11.4 Errors
8.1.12 BioAPI_QueryBFPs
8.1.12.1 Description
8.1.12.2 Parameters
8.1.12.3 Return Value
8.1.12.4 Errors
8.1.13 BioAPI_ControlUnit
8.1.13.1 Description
8.1.13.2 Parameters
8.1.13.3 Return Value
8.1.13.4 Errors
8.1.14 BioAPI_Control (BioAPI 2.1)
8.1.14.1 Description
8.1.14.2 Parameters
8.1.14.3 Return Value
8.1.14.4 Errors
8.1.15 BioAPI_Transform (BioAPI 2.1)
8.1.15.1 Description
8.1.15.2 Parameters
8.1.15.3 Return Value
8.1.15.4 Errors
8.1.16 BioAPI_LinkToEndpoint (BioAPI 2.1)
8.1.16.1 Description
8.1.16.2 Parameters
8.1.16.3 Return Value
8.1.16.4 Errors
8.1.17 BioAPI_UnlinkFromEndpoint (BioAPI 2.1)
8.1.17.1 Description
8.1.17.2 Parameters
8.1.17.3 Return Value
8.1.17.4 Errors
8.1.18 BioAPI_EnumFrameworks (BioAPI 2.1)
8.1.18.1 Description
8.1.18.2 Parameters
8.1.18.3 Return Value
8.1.18.4 Errors
8.2 Data Handle Operations
8.2.1 BioAPI_FreeBIRHandle
8.2.1.1 Description
8.2.1.2 Parameters
8.2.1.3 Return Value
8.2.1.4 Errors
8.2.2 BioAPI_GetBIRFromHandle
8.2.2.1 Description
8.2.2.2 Parameters
8.2.2.3 Return Value
8.2.2.4 Errors
8.2.3 BioAPI_GetHeaderFromHandle
8.2.3.1 Description
8.2.3.2 Parameters
8.2.3.3 Return Value
8.2.3.4 Errors
8.3 Callback and Event Operations
8.3.1 BioAPI_EnableEvents
8.3.1.1 Description
8.3.1.2 Parameters
8.3.1.3 Return Value
8.3.1.4 Errors
8.3.2 BioAPI_SetGUICallbacks (BioAPI 2.0)
8.3.2.1 Description
8.3.2.2 Parameters
8.3.2.3 Return Value
8.3.2.4 Errors
8.3.3 BioAPI_NotifyGUIProgressEvent (BioAPI 2.1)
8.3.3.1 Description
8.3.3.2 Parameters
8.3.3.3 Return Value
8.3.3.4 Errors
8.3.4 BioAPI_NotifyGUISelectEvent (BioAPI 2.1)
8.3.4.1 Description
8.3.4.2 Parameters
8.3.4.3 Return Value
8.3.4.4 Errors
8.3.5 BioAPI_NotifyGUIStateEvent (BioAPI 2.1)
8.3.5.1 Description
8.3.5.2 Parameters
8.3.5.3 Return Value
8.3.5.4 Errors
8.3.6 BioAPI_QueryGUIEventSubscriptions (BioAPI 2.1)
8.3.6.1 Description
8.3.6.2 Parameters
8.3.6.3 Return Value
8.3.6.4 Errors
8.3.7 BioAPI_RedirectGUIEvents (BioAPI 2.1)
8.3.7.1 Description
8.3.7.2 Parameters
8.3.7.3 Return Value
8.3.7.4 Errors
8.3.8 BioAPI_SubscribeToGUIEvents (BioAPI 2.1)
8.3.8.1 Description
8.3.8.2 Parameters
8.3.8.3 Return Value
8.3.8.4 Errors
8.3.9 BioAPI_UnredirectGUIEvents (BioAPI 2.1)
8.3.9.1 Description
8.3.9.2 Parameters
8.3.9.3 Return Value
8.3.9.4 Errors
8.3.10 BioAPI_UnsubscribeFromGUIEvents (BioAPI 2.1)
8.3.10.1 Description
8.3.10.2 Parameters
8.3.10.3 Return Value
8.3.10.4 Errors
8.3.11 BioAPI_EnableEventNotifications (BioAPI 2.1)
8.3.11.1 Description
8.3.11.2 Parameters
8.3.11.3 Return Value
8.3.11.4 Errors
8.4 Biometric Operations
8.4.1 BioAPI_Capture
8.4.1.1 Description
8.4.1.2 Parameters
8.4.1.3 Return Value
8.4.1.4 Errors
8.4.2 BioAPI_CreateTemplate
8.4.2.1 Description
8.4.2.2 Parameters
8.4.2.3 Return Value
8.4.2.4 Errors
8.4.3 BioAPI_Process
8.4.3.1 Description
8.4.3.2 Parameters
8.4.3.3 Return Value
8.4.3.4 Errors
8.4.4 BioAPI_ProcessWithAuxBIR (BioAPI2.0 and BioAPI2.1)
8.4.4.1 Description
8.4.4.2 Parameters
8.4.4.3 Return Value
8.4.4.4 Errors
8.4.5 BioAPI_ProcessUsingAuxBIRs (BioAPI 2.2)
8.4.5.1 Description
8.4.5.2 Parameters
8.4.5.3 Return Value
8.4.5.4 Errors
8.4.6 BioAPI_VerifyMatch
8.4.6.1 Description
8.4.6.2 Parameters
8.4.6.3 Return Value
8.4.6.4 Errors
8.4.7 BioAPI_VerifyMatchUsingAuxBIRs (BioAPI 2.2)
8.4.7.1 Description
8.4.7.2 Parameters
8.4.7.3 Return Value
8.4.7.4 Errors
8.4.8 BioAPI_IdentifyMatch
8.4.8.1 Description
8.4.8.2 Parameters
8.4.8.3 Return Value
8.4.8.4 Errors
8.4.9 BioAPI_Decide (BioAPI 2.2)
8.4.9.1 Description
8.4.9.2 Parameters
8.4.9.3 Return Value
8.4.9.4 Errors
8.4.10 BioAPI_Fuse (BioAPI 2.2)
8.4.10.1 Description
8.4.10.2 Parameters
8.4.10.3 Return Value
8.4.10.4 Errors
8.4.11 BioAPI_Enroll
8.4.11.1 Description
8.4.11.2 Parameters
8.4.11.3 Return Value
8.4.11.4 Errors
8.4.12 BioAPI_Verify
8.4.12.1 Description
8.4.12.2 Parameters
8.4.12.3 Return Value
8.4.12.4 Errors
8.4.13 BioAPI_Identify
8.4.13.1 Description
8.4.13.2 Parameters
8.4.13.3 Return Value
8.4.13.4 Errors
8.4.14 BioAPI_Import
8.4.14.1 Description
8.4.14.2 Parameters
8.4.14.3 Return Value
8.4.14.4 Errors
8.4.15 BioAPI_Export (BioAPI 2.2)
8.4.15.1 Description
8.4.15.2 Parameters
8.4.15.3 Return Value
8.4.15.4 Errors
8.4.16 BioAPI_PresetIdentifyPopulation
8.4.16.1 Description
8.4.16.2 Parameters
8.4.16.3 Return Value
8.4.16.4 Errors
8.5 Database Operations
8.5.1 BioAPI_DbOpen
8.5.1.1 Description
8.5.1.2 Parameters
8.5.1.3 Return Value
8.5.1.4 Errors
8.5.2 BioAPI_DbClose
8.5.2.1 Description
8.5.2.2 Parameters
8.5.2.3 Return Value
8.5.2.4 Errors
8.5.3 BioAPI_DbCreate
8.5.3.1 Description
8.5.3.2 Parameters
8.5.3.3 Return Value
8.5.3.4 Errors
8.5.4 BioAPI_DbDelete
8.5.4.1 Description
8.5.4.2 Parameters
8.5.4.3 Return Value
8.5.4.4 Errors
8.5.5 BioAPI_DbSetMarker
8.5.5.1 Description
8.5.5.2 Parameters
8.5.5.3 Return Value
8.5.5.4 Errors
8.5.6 BioAPI_DbFreeMarker
8.5.6.1 Description
8.5.6.2 Parameters
8.5.6.3 Return Value
8.5.6.4 Errors
8.5.7 BioAPI_DbStoreBIR
8.5.7.1 Description
8.5.7.2 Parameters
8.5.7.3 Return Value
8.5.7.4 Errors
8.5.8 BioAPI_DbGetBIR
8.5.8.1 Description
8.5.8.2 Parameters
8.5.8.3 Return Value
8.5.8.4 Errors
8.5.9 BioAPI_DbGetNextBIR
8.5.9.1 Description
8.5.9.2 Parameters
8.5.9.3 Return Value
8.5.9.4 Errors
8.5.10 BioAPI_DbDeleteBIR
8.5.10.1 Description
8.5.10.2 Parameters
8.5.10.3 Return Value
8.5.10.4 Errors
8.6 BioAPI Unit operations
8.6.1 BioAPI_SetPowerMode
8.6.1.1 Description
8.6.1.2 Parameters
8.6.1.3 Return Value
8.6.1.4 Errors
8.6.2 BioAPI_SetIndicatorStatus
8.6.2.1 Description
8.6.2.2 Parameters
8.6.2.3 Return Value
8.6.2.4 Errors
8.6.3 BioAPI_GetIndicatorStatus
8.6.3.1 Description
8.6.3.2 Parameters
8.6.3.3 Return Value
8.6.3.4 Errors
8.6.4 BioAPI_CalibrateSensor
8.6.4.1 Description
8.6.4.2 Parameters
8.6.4.3 Return Value
8.6.4.4 Errors
8.7 Utility Functions
8.7.1 BioAPI_Cancel
8.7.1.1 Description
8.7.1.2 Parameters
8.7.1.3 Return Value
8.7.1.4 Errors
8.7.2 BioAPI_Free
8.7.2.1 Description
8.7.2.2 Parameters
8.7.2.3 Return Value
8.7.2.4 Errors
9 BioAPI Service Provider Interface
9.1 Summary
9.2 Type Definitions for Biometric Service Providers
9.2.1 BioSPI_EventHandler
9.2.1.1 Definitions
9.2.2 BioSPI_BFP_ENUMERATION_HANDLER
9.2.2.1 Definition
9.2.2.2 Parameters
9.2.2.3 Return Value
9.2.2.4 Errors
9.2.3 BioSPI_MEMORY_FREE_HANDLER
9.2.3.1 Definition
9.2.3.2 Parameters
9.2.3.3 Return Value
9.2.3.4 Errors
9.2.4 BioSPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1)
9.2.4.1 Callback function
9.2.4.2 Description
9.2.4.3 Parameters
9.2.4.4 Return Value
9.2.4.5 Errors
9.2.5 BioSPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1)
9.2.5.1 Callback function
9.2.5.2 Description
9.2.5.3 Parameters
9.2.5.4 Return Value
9.2.5.5 Errors
9.2.6 BioSPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1)
9.2.6.1 Callback function
9.2.6.2 Description
9.2.6.3 Parameters
9.2.6.4 Return Value
9.2.6.5 Errors
9.3 Biometric Service Provider Operations
9.3.1 SPI Component Management Operations
9.3.1.1 BioSPI_BSPLoad
9.3.1.1.1 Description
9.3.1.1.2 Parameters
9.3.1.1.3 Return Value
9.3.1.1.4 Errors
9.3.1.2 BioSPI_BSPUnload
9.3.1.2.1 Description
9.3.1.2.2 Parameters
9.3.1.2.3 Return Value
9.3.1.2.4 Errors
9.3.1.3 BioSPI_BSPAttach
9.3.1.3.1 Description
9.3.1.3.2 Parameters
9.3.1.3.3 Return Value
9.3.1.3.4 Errors
9.3.1.4 BioSPI_BSPAttachSecure (BioAPI 2.2)
9.3.1.4.1 Description
9.3.1.4.2 Parameters
9.3.1.4.3 Return Value
9.3.1.4.4 Errors
9.3.1.5 BioSPI_BSPDetach
9.3.1.5.1 Description
9.3.1.5.2 Parameters
9.3.1.5.3 Return Value
9.3.1.5.4 Errors
9.3.1.6 BioSPI_QueryUnits
9.3.1.7 BioSPI_QueryBFPs
9.3.1.8 BioSPI_ControlUnit
9.3.1.9 BioSPI_Control (BioAPI 2.1)
9.3.1.10 BioSPI_Transform (BioAPI 2.1)
9.3.2 SPI Data Handle Operations
9.3.2.1 BioSPI_FreeBIRHandle
9.3.2.2 BioSPI_GetBIRFromHandle
9.3.2.3 BioSPI_GetHeaderFromHandle
9.3.3 SPI Callback and Event Operations
9.3.3.1 BioSPI_EnableEvents
9.3.3.2 BioSPI_SetGUICallbacks (BioAPI 2.0)
9.3.3.3 BioSPI_SubscribeToGUIEvents (BioAPI 2.1)
9.3.3.3.1 Parameters
9.3.3.4 BioSPI_UnsubscribeFromGUIEvents (BioAPI 2.1)
9.3.3.4.1 Parameters
9.3.4 SPI Biometric Operations
9.3.4.1 BioSPI_Capture
9.3.4.2 BioSPI_CreateTemplate
9.3.4.3 BioSPI_Process
9.3.4.4 BioSPI_ProcessWithAuxBIR
9.3.4.5 BioSPI_ProcessUsingAuxBIRs (BioAPI 2.2)
9.3.4.6 BioSPI_VerifyMatch
9.3.4.7 BioSPI_ VerifyMatchUsingAuxBIRs (BioAPI 2.2)
9.3.4.8 BioSPI_IdentifyMatch
9.3.4.9 BioSPI_Decide (BioAPI 2.2)
9.3.4.10 BioSPI_Fuse (BioAPI 2.2)
9.3.4.11 BioSPI_Enroll
9.3.4.12 BioSPI_Verify
9.3.4.13 BioSPI_Identify
9.3.4.14 BioSPI_Import
9.3.4.15 BioSPI_Export (BioAPI 2.2)
9.3.4.16 BioSPI_PresetIdentifyPopulation
9.3.5 SPI Database Operations
9.3.5.1 BioSPI_DbOpen
9.3.5.2 BioSPI_DbClose
9.3.5.3 BioSPI_DbCreate
9.3.5.4 BioSPI_DbDelete
9.3.5.5 BioSPI_DbSetMarker
9.3.5.6 BioSPI_DbFreeMarker
9.3.5.7 BioSPI_DbStoreBIR
9.3.5.8 BioSPI_DbGetBIR
9.3.5.9 BioSPI_DbGetNextBIR
9.3.5.10 BioSPI_DbDeleteBIR
9.3.6 SPI BioAPI Unit operations
9.3.6.1 BioSPI_SetPowerMode
9.3.6.2 BioSPI_SetIndicatorStatus
9.3.6.3 BioSPI_GetIndicatorStatus
9.3.6.4 BioSPI_CalibrateSensor
9.3.7 SPI Utility Functions
9.3.7.1 BioSPI_Cancel
9.3.7.2 BioSPI_Free
10 Component registry interface
10.1 BioAPI Registry Schema
10.1.1 Framework Schema
10.1.2 BSP Schema
10.1.3 BFP Schema
10.2 Component registry functions
10.2.1 BioAPI_Util_InstallBSP
10.2.1.1 Description
10.2.1.2 Parameters
10.2.1.3 Return Values
10.2.2 BioAPI_Util_InstallBFP
10.2.2.1 Description
10.2.2.2 Parameters
10.2.2.3 Return Values
10.2.3 BioAPI_RegisterBSP (BioAPI 2.1)
10.2.3.1 Description
10.2.3.2 Parameters
10.2.3.3 Return Value
10.2.3.4 Errors
10.2.4 BioAPI_UnregisterBSP (BioAPI 2.1)
10.2.4.1 Description
10.2.4.2 Parameters
10.2.4.3 Return Value
10.2.4.4 Errors
10.2.5 ioAPI_RegisterBFP (BioAPI 2.1)
10.2.5.1 Description
10.2.5.2 Parameters
10.2.5.3 Return Value
10.2.5.4 Errors
10.2.6 BioAPI_UnregisterBFP (BioAPI 2.1)
10.2.6.1 Description
10.2.6.2 Parameters
10.2.6.3 Return Value
10.2.6.4 Errors
10.2.7 BioAPI_GetLastErrorInfo (BioAPI 2.1)
10.2.7.1 Description
10.2.7.2 Parameters
10.2.7.3 Return Value
10.2.7.4 Errors
11 BioAPI error handling
11.1 Error Values and Error Codes Scheme
11.2 Error Codes and Error Value Enumeration
11.2.1 BioAPI Error Value Constants
11.2.2 Implementation-Specific Error Codes
11.2.3 General Error Codes
11.2.4 Component Management Error Codes
11.2.5 Database Error Values
11.2.6 Location Error Values
11.2.6.1 General location error codes
11.2.6.2 Specific location error codes
11.2.7 Quality Error Codes
11.2.8 Security Error Codes (BioAPI 2.2)
Annex A
A.1 General
A.1.1
A.1.2
A.2 BioAPI Conformant Biometric Application
A.2.1
A.2.2
A.3 BioAPI Conformant Framework
A.3.1
A.3.2
A.3.3
A.3.4
A.3.5
A.3.6
A.4 BioAPI Conformant BSPs
A.4.1 BioAPI Conformant Verification BSPs
A.4.1.1
A.4.1.2
A.4.2 BioAPI Conformant Identification BSPs
A.4.2.1
A.4.2.2
A.4.2.3
A.4.3 BioAPI Conformant Capture BSPs
A.4.3.1
A.4.4 BioAPI Conformant Verification Engines
A.4.4.1
A.4.4.2
A.4.4.3
A.4.5 BioAPI Conformant Identification Engines
A.4.5.1 BioSPI_IdentifyMatch
A.4.6 Optional Capabilities
A.4.6.1 Optional Functions
A.4.6.1.1
A.4.6.1.1.1
A.4.6.1.1.2
A.4.6.1.1.3
A.4.6.1.1.4
A.4.6.1.1.5
A.4.6.1.1.6
A.4.6.1.1.7
A.4.6.1.1.8
A.4.6.1.1.9
A.4.6.1.1.10
A.4.6.1.2
A.4.6.1.3
A.4.6.1.4
A.4.6.1.5
A.4.6.1.6
A.4.6.2 Optional Subfunctions
A.4.6.2.1
A.4.6.2.2
A.4.6.2.3
A.4.6.2.4
A.4.6.2.5
A.4.6.2.6
A.4.6.2.7
A.4.6.2.8
A.4.6.2.9
A.4.6.2.10
A.4.6.2.11
A.4.6.2.12
A.4.6.2.13
A.4.6.2.14
A.4.6.2.15
A.4.6.2.16
A.4.6.2.17
A.4.6.2.18
Annex B
B.1 Patron
B.2 Patron identifier
B.3 Patron format name
B.4 Patron format identifier
B.5 ASN.1 object identifier for this patron format
B.6 Domain of Use
B.7 Version identifier
B.8 CBEFF version
B.9 General
B.10 Specification
B.11 Patron format conformance statement
B.11.1 Identifying information
B.11.2 CBEFF-defined data elements and abstract values
B.11.3 Patron-defined data elements and abstract values
Annex C
C.1 Application Level API
C.1.1
C.1.2
C.1.3
C.1.4
C.2 Biometric technology
C.2.1
C.2.2
C.2.3
C.3 Biometric Functions
C.3.1
C.3.2
C.3.3
C.3.4
C.3.4.1
C.3.4.2
C.3.4.3
C.3.4.4
C.4 BioAPI Scoring and Thresholding
C.4.1
C.4.2
C.4.3
C.4.4
C.4.5
C.4.6
C.4.7
C.4.8
C.5 Payloads
C.5.1
C.5.2
C.5.3
C.5.4
C.6 Timeout
C.7 BIR Databases
C.7.1
C.7.2
C.7.3
C.7.4
C.7.5
C.7.6
C.7.7
C.7.8
C.7.9
C.8 User Interface Considerations (BioAPI 2.1)
C.8.1 General
C.8.2 Example of a sequence of GUI event notifications for an Enroll operation (enroll type = Test-Verify, no errors or restarts)
C.8.3 Example of a sequence of GUI event notifications for an Enroll operation (enroll type = Multiple-Capture, no errors or restarts, one recapture)
C.8.4 Example of a sequence of GUI event notifications for an Identify operation (no errors or restarts)
C.9 Match-On-Card (MOC)
C.9.1
C.9.2
C.9.3
C.9.4
C.9.5
C.9.6
Annex D
D.1 Simple Sequence of Calls
D.1.1 Initialization
D.1.2 Load and Attach the BSP
D.1.3 Enroll a Subject
D.1.4 Perform the Verification
D.1.5 Detach and Unload the BSP
D.1.6 Close the Framework
D.2 Sample BIR Conversion
D.3 Calling sequences with BioGUI (BioAPI 2.1)
D.3.1 Enroll with BioGUI
D.3.2 Perform a verification with BioGUI
Annex E
Bibliography
Cited references in this standard
Content history
[Current]
[Superseded]
DR2 AS ISO/IEC 19784.1:2019
AS ISO IEC 19784.1-2007
Please select a variation to view its description.
| Published | 13/12/2019 |
|---|---|
| Pages | 233 |
Please select a variation to view its pdf.
