šŸ”„šŸ”„ Donā€™t Miss Out on Our End of Autumn Sale. If you have any questions, feel free to click the bottom right corner to contact our customer service..

Concat us[email protected]
Shopping Cart

No products in the cart.

šŸ”
BS ISO/IEC 19784-1:2018

BS ISO/IEC 19784-1:2018

$215.11

Information technology. Biometric application programming interface – BioAPI specification

Published By Publication Date Number of Pages
BSI 2018 248
PDF Format Searchable Printable Preview Now
Guaranteed Safe Checkout
Categories: ,

If you have any questions, feel free to reach out to our online customer service team by clicking on the bottom right corner. Weā€™re here to assist you 24/7.
Email:[email protected]

This document defines 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.

For use in a system that does not include a BioAPI Framework (called a framework-free BioAPI system), only the SPI interface is applicable, with applications interfacing directly to that in a platform-specific manner.

NOTE 1 Many clauses and/or sub-clauses of this document are not applicable for implementation of a framework-free BioAPI system. These are identified at the head of the clause of sub-clause.

The BioAPI specification is applicable to a broad range of biometric technology types. It is also applicable to a wide variety of biometrically enabled applications, from personal devices, through network security applications, to large complex identification systems.

This document supports an architecture in which a BioAPI Framework supports multiple simultaneous biometric applications (provided by different vendors), using multiple dynamically installed and loaded (or unloaded) Biometric Service Provider (BSP) components and BioAPI Units (provided by other different vendors), possibly using one of an alternative set of BioAPI Function Provider (BFP) components (provided by other vendors) or by direct management of BioAPI Units.

NOTE 2 Where BioAPI Units are provided by a different vendor fom a BSP, a standardised BioAPI Function Provider Interface (FPI) may be needed. This is outside the scope of this document, but is specified by later parts for the different categories of FPI.

NOTE 3 Where a BioAPI Framework is not used in a system, the ability to support multiple applications and multiple BSPs is platform-dependent and depends on the nature of the system-integration techniques employed.

This document is not required (and should normally not be referenced) when a complete biometric system is being procured from a single vendor, particularly if the addition or interchange of biometric hardware, services, or applications is not a feature of that biometric system. (Such systems are sometimes referred to as “embedded systems”.) Standardisation of such systems is not in the scope of this document.

This document does not define security requirements for biometric applications and biometric service providers.

NOTE 4 ISO 19092 provides guidelines on security aspects of biometric systems[3].

The performance of biometric systems (particularly in relation to searches of a large population to provide the biometric identification capability) is not in the scope of this document. Trade-offs between interoperability and performance are not in the scope of this document.

This document specifies a version of the BioAPI specification that is defined to have a version number described as Major 2, Minor 0, or version 2.0. It also specifies a version number described as Major 2, Minor 1, or version 2.1 that provides an enhanced Graphical User Interface. It also specifies a version number described as Major 2, Minor 2, or version 2.2 that provides features supporting fusion and security. Some clauses and sub-clauses apply only to one of these versions, some to two or more. This is identified at the head of the relevant clauses and sub-clauses.

NOTE 5 Earlier versions of the BioAPI specification were not International Standards.

NOTE 6 The differences between the requirements of the 2.0 specification and the 2.1 specification for framework-free operation relate only to the biometric type values and encodings.

Conformance requirements are specified in Clause 5.

PDF Catalog

PDF Pages PDF Title
2 National foreword
10 Foreword
11 Introduction
13 1 Scope
14 2 Normative references
3 Terms and definitions
20 4 Symbols and abbreviated terms
5 Conformance
21 6 The BioAPI architecture
6.1 The full BioAPI API/SPI Architectural Model
22 6.2 The framework-free BioAPI Architectural Model
6.3 The BioAPI BSP Architectural Model
24 6.4 The component registry
25 6.5 BSP and BFP Installation and De-installation
26 6.6 BSP Load and BioAPI Unit Attachment
27 6.7 Controlling BioAPI Units
6.8 BIR Structure and Handling
6.8.1 BIR Structure
28 6.8.2 BIR Data Handling
29 7 BioAPI types and macros
7.1 BioAPI
7.2 BioAPI_ACBio_PARAMETERS (BioAPI 2.2)
7.2.2 Definitions
7.3 BioAPI_ASN1_BIR (BioAPI 2.2)
30 7.4 BioAPI_ASN1_ENCODED (BioAPI 2.2)
7.5 BioAPI_BFP_LIST_ELEMENT
7.5.2 Definitions
7.6 BioAPI_BFP_SCHEMA
7.6.2 Definitions
31 7.7 BioAPI_BIR
7.8 BioAPI_BIR_ARRAY_POPULATION
32 7.9 BioAPI_BIR_BIOMETRIC_DATA_FORMAT
7.10 BioAPI_BIR_BIOMETRIC_PRODUCT_ID
7.11 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.0)
33 7.12 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.1)
34 7.13 BioAPI_BIR_DATA_TYPE
35 7.14 BioAPI_BIR_HANDLE
7.15 BioAPI_BIR_HEADER
36 7.16 BioAPI_BIR_PURPOSE
37 7.17 BioAPI_BIR_SECURITY_BLOCK_FORMAT
7.18 BioAPI_BIR_SUBTYPE (BioAPI 2.0)
38 7.19 BioAPI_BIR_SUBTYPE (BioAPI 2.1)
39 7.20 BioAPI_BIR_SUBTYPE_MASK (BioAPI 2.1)
40 7.21 BioAPI_BOOL
7.22 BioAPI_BSP_SCHEMA (BioAPI 2.0)
41 7.22.2 Definitions
42 7.23 BioAPI_BSP_SCHEMA (BioAPI 2.1)
7.23.3 Definitions
44 7.24 BioAPI_CANDIDATE
7.25 BioAPI_CATEGORY
7.26 BioAPI_DATA
7.26.2 Definitions
7.27 BioAPI_DATE
45 7.28 BioAPI_DB_ACCESS_TYPE
7.29 BioAPI_DB_MARKER_HANDLE
7.30 BioAPI_DB_HANDLE
7.31 BioAPI_DBBIR_ID
46 7.32 BioAPI_DTG
7.33 BioAPI_ENCRYPTION_ALG (BioAPI 2.2)
7.34 BioAPI_ENCRYPTION_INFO (BioAPI 2.2)
7.34.2 Definitions
7.35 BioAPI_ERROR_INFO (BioAPI 2.1)
47 7.36 BioAPI_EVENT
7.37 BioAPI_EVENT_MASK
7.38 BioAPI_EventHandler
48 7.38.2 Definitions
7.39 BioAPI_FMR
7.40 BioAPI_FRAMEWORK_SCHEMA
7.40.2 Definitions
49 7.41 BioAPI_GUI_BITMAP (BioAPI 2.0)
7.41.2 Definitions
7.42 BioAPI_GUI_BITMAP (BioAPI 2.1)
50 7.42.3 Definitions
7.43 BioAPI_GUI_BITMAP_ARRAY (BioAPI 2.1)
7.44 BioAPI_GUI_ENROLL_TYPE (BioAPI 2.1)
51 7.45 BioAPI_GUI_EVENT_SUBSCRIPTION (BioAPI 2.1)
7.46 BioAPI_GUI_MESSAGE (BioAPI 2.0)
52 7.47 BioAPI_GUI_MOMENT (BioAPI 2.1)
53 7.48 BioAPI_GUI_OPERATION (BioAPI 2.1)
7.49 BioAPI_GUI_PROGRESS (BioAPI 2.0)
54 7.50 BioAPI_GUI_PROGRESS (BioAPI 2.1)
7.51 BioAPI_GUI_RESPONSE (BioAPI 2.0)
7.52 BioAPI_GUI_RESPONSE (BioAPI 2.1)
56 7.53 BioAPI_GUI_STATE (BioAPI 2.0)
7.54 BioAPI_GUI_STATE_CALLBACK (BioAPI 2.0)
7.54.2 Function
57 7.54.3 Parameters
7.55 BioAPI_GUI_STREAMING_CALLBACK (BioAPI 2.0)
7.55.2 Function
7.55.3 Parameters
58 7.56 BioAPI_GUI_SUBOPERATION (BioAPI 2.1)
59 7.57 BioAPI_HANDLE
7.58 BioAPI_HASH_ALG (BioAPI 2.2)
7.59 BioAPI_IDENTIFY_POPULATION
7.60 BioAPI_IDENTIFY_POPULATION_TYPE
60 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
61 7.66 BioAPI_KEY_INFO (BioAPI 2.2)
7.66.2 Definitions
7.67 BioAPI_KEY_TRANSPORT (BioAPI 2.2)
7.67.2 Definitions
7.68 BioAPI_MAC_ALG (BioAPI 2.2)
7.69 BioAPI_MAC_INFO (BioAPI 2.2)
7.69.2 Definitions
62 7.70 BioAPI_OPERATIONS_MASK
7.71 BioAPI_OPTIONS_MASK
64 7.72 BioAPI_POWER_MODE
7.73 BioAPI_QUALITY
65 7.74 BioAPI_RETURN
7.74.2 Definitions
7.75 BioAPI_SECURITY_OPTIONS_MASK (BioAPI 2.2)
7.76 BioAPI_SECURITY_PROFILE (BioAPI 2.2)
66 7.76.2 Definitions
7.77 BioAPI_DIGITAL_SIGNATURE_ALG (BioAPI 2.2)
67 7.78 BioAPI_STRING
7.79 BioAPI_TIME
7.80 BioAPI_UNIT_ID
7.81 BioAPI_UNIT_LIST_ELEMENT
7.81.2 Definitions
7.82 BioAPI_UNIT_SCHEMA
68 7.82.2 Definitions
69 7.83 BioAPI_UNIT_SCHEMA (BioAPI 2.2)
7.83.2 Definitions
70 7.84 BioAPI_UUID
7.85 BioAPI_VERSION
7.86 GUI Events
7.86.1 BioAPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1)
73 7.86.2 BioAPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1)
75 7.86.3 BioAPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1)
77 8 BioAPI functions
8.1 Component Management Functions
8.1.1 BioAPI_Init
8.1.2 BioAPI_Terminate
78 8.1.3 BioAPI_GetFrameworkInfo
8.1.4 BioAPI_EnumBSPs
79 8.1.5 BioAPI_BSPLoad
81 8.1.6 BioAPI_BSPUnload
8.1.7 BioAPI_BSPAttach
83 8.1.8 BioAPI_BSPAttachSecure (BioAPI 2.2)
85 8.1.9 BioAPI_BSPDetach
8.1.10 BioAPI_QueryUnits
86 8.1.11 BioAPI_EnumBFPs
87 8.1.12 BioAPI_QueryBFPs
88 8.1.13 BioAPI_ControlUnit
89 8.1.14 BioAPI_Control (BioAPI 2.1)
90 8.1.15 BioAPI_Transform (BioAPI 2.1)
91 8.1.16 BioAPI_LinkToEndpoint (BioAPI 2.1)
92 8.1.17 BioAPI_UnlinkFromEndpoint (BioAPI 2.1)
8.1.18 BioAPI_EnumFrameworks (BioAPI 2.1)
93 8.2 Data Handle Operations
8.2.1 BioAPI_FreeBIRHandle
94 8.2.2 BioAPI_GetBIRFromHandle
8.2.3 BioAPI_GetHeaderFromHandle
95 8.3 Callback and Event Operations
8.3.1 BioAPI_EnableEvents
96 8.3.2 BioAPI_SetGUICallbacks (BioAPI 2.0)
8.3.3 BioAPI_NotifyGUIProgressEvent (BioAPI 2.1)
97 8.3.4 BioAPI_NotifyGUISelectEvent (BioAPI 2.1)
98 8.3.5 BioAPI_NotifyGUIStateEvent (BioAPI 2.1)
100 8.3.6 BioAPI_QueryGUIEventSubscriptions (BioAPI 2.1)
101 8.3.7 BioAPI_RedirectGUIEvents (BioAPI 2.1)
103 8.3.8 BioAPI_SubscribeToGUIEvents (BioAPI 2.1)
105 8.3.9 BioAPI_UnredirectGUIEvents (BioAPI 2.1)
8.3.10 BioAPI_UnsubscribeFromGUIEvents (BioAPI 2.1)
106 8.3.11 BioAPI_EnableEventNotifications (BioAPI 2.1)
107 8.4 Biometric Operations
8.4.1 BioAPI_Capture
109 8.4.2 BioAPI_CreateTemplate
110 8.4.3 BioAPI_Process
111 8.4.4 BioAPI_ProcessWithAuxBIR (BioAPI2.0 and BioAPI2.1)
112 8.4.5 BioAPI_ProcessUsingAuxBIRs (BioAPI 2.2)
114 8.4.6 BioAPI_VerifyMatch
116 8.4.7 BioAPI_VerifyMatchUsingAuxBIRs (BioAPI 2.2)
118 8.4.8 BioAPI_IdentifyMatch
120 8.4.9 BioAPI_Decide (BioAPI 2.2)
122 8.4.10 BioAPI_Fuse (BioAPI 2.2)
123 8.4.11 BioAPI_Enroll
125 8.4.12 BioAPI_Verify
127 8.4.13 BioAPI_Identify
130 8.4.14 BioAPI_Import
131 8.4.15 BioAPI_Export (BioAPI 2.2)
132 8.4.16 BioAPI_PresetIdentifyPopulation
8.5 Database Operations
8.5.1 BioAPI_DbOpen
133 8.5.2 BioAPI_DbClose
134 8.5.3 BioAPI_DbCreate
135 8.5.4 BioAPI_DbDelete
8.5.5 BioAPI_DbSetMarker
136 8.5.6 BioAPI_DbFreeMarker
8.5.7 BioAPI_DbStoreBIR
137 8.5.8 BioAPI_DbGetBIR
138 8.5.9 BioAPI_DbGetNextBIR
139 8.5.10 BioAPI_DbDeleteBIR
140 8.6 BioAPI Unit operations
8.6.1 BioAPI_SetPowerMode
141 8.6.2 BioAPI_SetIndicatorStatus
8.6.3 BioAPI_GetIndicatorStatus
142 8.6.4 BioAPI_CalibrateSensor
8.7 Utility Functions
8.7.1 BioAPI_Cancel
143 8.7.2 BioAPI_Free
144 9 BioAPI Service Provider Interface
9.1 Summary
9.2 Type Definitions for Biometric Service Providers
9.2.1 BioSPI_EventHandler
145 9.2.2 BioSPI_BFP_ENUMERATION_HANDLER
146 9.2.3 BioSPI_MEMORY_FREE_HANDLER
9.2.4 BioSPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1)
147 9.2.5 BioSPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1)
148 9.2.6 BioSPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1)
149 9.3 Biometric Service Provider Operations
9.3.1 SPI Component Management Operations
154 9.3.2 SPI Data Handle Operations
155 9.3.3 SPI Callback and Event Operations
156 9.3.4 SPI Biometric Operations
160 9.3.5 SPI Database Operations
161 9.3.6 SPI BioAPI Unit operations
162 9.3.7 SPI Utility Functions
10 Component registry interface
163 10.1 BioAPI Registry Schema
10.1.1 Framework Schema
10.1.2 BSP Schema
165 10.1.3 BFP Schema
166 10.2 Component registry functions
10.2.1 BioAPI_Util_InstallBSP
167 10.2.2 BioAPI_Util_InstallBFP
10.2.3 BioAPI_RegisterBSP (BioAPI 2.1)
168 10.2.4 BioAPI_UnregisterBSP (BioAPI 2.1)
169 10.2.5 ioAPI_RegisterBFP (BioAPI 2.1)
170 10.2.6 BioAPI_UnregisterBFP (BioAPI 2.1)
10.2.7 BioAPI_GetLastErrorInfo (BioAPI 2.1)
171 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
173 11.2.4 Component Management Error Codes
174 11.2.5 Database Error Values
11.2.6 Location Error Values
176 11.2.7 Quality Error Codes
177 11.2.8 Security Error Codes (BioAPI 2.2)
179 Annex A (normative) Conformance
196 Annex B (normative) CBEFF Patron Format Specification: BioAPI patron format
202 Annex C (informative) Specification overview
226 Annex D (informative) Calling sequence examples and sample code
244 Annex E (normative) ASN.1 specification of BioAPI_BIR (BioAPI2.2)
246 Bibliography

Related products

BS ISO/IEC 19784-1:2018
$215.11