BS ISO/IEC 19784-1:2018 – TC:2020 Edition
$280.87
Tracked Changes. Information technology. Biometric application programming interface – BioAPI specification
Published By | Publication Date | Number of Pages |
BSI | 2020 | 662 |
PDF Catalog
PDF Pages | PDF Title |
---|---|
416 | National foreword |
424 | Foreword |
425 | Introduction |
427 | 1 Scope |
428 | 2 Normative references 3 Terms and definitions |
434 | 4 Symbols and abbreviated terms 5 Conformance |
435 | 6 The BioAPI architecture 6.1 The full BioAPI API/SPI Architectural Model |
436 | 6.2 The framework-free BioAPI Architectural Model 6.3 The BioAPI BSP Architectural Model |
438 | 6.4 The component registry |
439 | 6.5 BSP and BFP Installation and De-installation |
440 | 6.6 BSP Load and BioAPI Unit Attachment |
441 | 6.7 Controlling BioAPI Units 6.8 BIR Structure and Handling 6.8.1 BIR Structure |
442 | 6.8.2 BIR Data Handling |
443 | 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) |
444 | 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 |
445 | 7.7 BioAPI_BIR 7.8 BioAPI_BIR_ARRAY_POPULATION |
446 | 7.9 BioAPI_BIR_BIOMETRIC_DATA_FORMAT 7.10 BioAPI_BIR_BIOMETRIC_PRODUCT_ID 7.11 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.0) |
447 | 7.12 BioAPI_BIR_BIOMETRIC_TYPE (BioAPI 2.1) |
448 | 7.13 BioAPI_BIR_DATA_TYPE |
449 | 7.14 BioAPI_BIR_HANDLE 7.15 BioAPI_BIR_HEADER |
450 | 7.16 BioAPI_BIR_PURPOSE |
451 | 7.17 BioAPI_BIR_SECURITY_BLOCK_FORMAT 7.18 BioAPI_BIR_SUBTYPE (BioAPI 2.0) |
452 | 7.19 BioAPI_BIR_SUBTYPE (BioAPI 2.1) |
453 | 7.20 BioAPI_BIR_SUBTYPE_MASK (BioAPI 2.1) |
454 | 7.21 BioAPI_BOOL 7.22 BioAPI_BSP_SCHEMA (BioAPI 2.0) |
455 | 7.22.2 Definitions |
456 | 7.23 BioAPI_BSP_SCHEMA (BioAPI 2.1) 7.23.3 Definitions |
458 | 7.24 BioAPI_CANDIDATE 7.25 BioAPI_CATEGORY 7.26 BioAPI_DATA 7.26.2 Definitions 7.27 BioAPI_DATE |
459 | 7.28 BioAPI_DB_ACCESS_TYPE 7.29 BioAPI_DB_MARKER_HANDLE 7.30 BioAPI_DB_HANDLE 7.31 BioAPI_DBBIR_ID |
460 | 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) |
461 | 7.36 BioAPI_EVENT 7.37 BioAPI_EVENT_MASK 7.38 BioAPI_EventHandler |
462 | 7.38.2 Definitions 7.39 BioAPI_FMR 7.40 BioAPI_FRAMEWORK_SCHEMA 7.40.2 Definitions |
463 | 7.41 BioAPI_GUI_BITMAP (BioAPI 2.0) 7.41.2 Definitions 7.42 BioAPI_GUI_BITMAP (BioAPI 2.1) |
464 | 7.42.3 Definitions 7.43 BioAPI_GUI_BITMAP_ARRAY (BioAPI 2.1) 7.44 BioAPI_GUI_ENROLL_TYPE (BioAPI 2.1) |
465 | 7.45 BioAPI_GUI_EVENT_SUBSCRIPTION (BioAPI 2.1) 7.46 BioAPI_GUI_MESSAGE (BioAPI 2.0) |
466 | 7.47 BioAPI_GUI_MOMENT (BioAPI 2.1) |
467 | 7.48 BioAPI_GUI_OPERATION (BioAPI 2.1) 7.49 BioAPI_GUI_PROGRESS (BioAPI 2.0) |
468 | 7.50 BioAPI_GUI_PROGRESS (BioAPI 2.1) 7.51 BioAPI_GUI_RESPONSE (BioAPI 2.0) 7.52 BioAPI_GUI_RESPONSE (BioAPI 2.1) |
470 | 7.53 BioAPI_GUI_STATE (BioAPI 2.0) 7.54 BioAPI_GUI_STATE_CALLBACK (BioAPI 2.0) 7.54.2 Function |
471 | 7.54.3 Parameters 7.55 BioAPI_GUI_STREAMING_CALLBACK (BioAPI 2.0) 7.55.2 Function 7.55.3 Parameters |
472 | 7.56 BioAPI_GUI_SUBOPERATION (BioAPI 2.1) |
473 | 7.57 BioAPI_HANDLE 7.58 BioAPI_HASH_ALG (BioAPI 2.2) 7.59 BioAPI_IDENTIFY_POPULATION 7.60 BioAPI_IDENTIFY_POPULATION_TYPE |
474 | 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 |
475 | 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 |
476 | 7.70 BioAPI_OPERATIONS_MASK 7.71 BioAPI_OPTIONS_MASK |
478 | 7.72 BioAPI_POWER_MODE 7.73 BioAPI_QUALITY |
479 | 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) |
480 | 7.76.2 Definitions 7.77 BioAPI_DIGITAL_SIGNATURE_ALG (BioAPI 2.2) |
481 | 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 |
482 | 7.82.2 Definitions |
483 | 7.83 BioAPI_UNIT_SCHEMA (BioAPI 2.2) 7.83.2 Definitions |
484 | 7.84 BioAPI_UUID 7.85 BioAPI_VERSION 7.86 GUI Events 7.86.1 BioAPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1) |
487 | 7.86.2 BioAPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1) |
489 | 7.86.3 BioAPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1) |
491 | 8 BioAPI functions 8.1 Component Management Functions 8.1.1 BioAPI_Init 8.1.2 BioAPI_Terminate |
492 | 8.1.3 BioAPI_GetFrameworkInfo 8.1.4 BioAPI_EnumBSPs |
493 | 8.1.5 BioAPI_BSPLoad |
495 | 8.1.6 BioAPI_BSPUnload 8.1.7 BioAPI_BSPAttach |
497 | 8.1.8 BioAPI_BSPAttachSecure (BioAPI 2.2) |
499 | 8.1.9 BioAPI_BSPDetach 8.1.10 BioAPI_QueryUnits |
500 | 8.1.11 BioAPI_EnumBFPs |
501 | 8.1.12 BioAPI_QueryBFPs |
502 | 8.1.13 BioAPI_ControlUnit |
503 | 8.1.14 BioAPI_Control (BioAPI 2.1) |
504 | 8.1.15 BioAPI_Transform (BioAPI 2.1) |
505 | 8.1.16 BioAPI_LinkToEndpoint (BioAPI 2.1) |
506 | 8.1.17 BioAPI_UnlinkFromEndpoint (BioAPI 2.1) 8.1.18 BioAPI_EnumFrameworks (BioAPI 2.1) |
507 | 8.2 Data Handle Operations 8.2.1 BioAPI_FreeBIRHandle |
508 | 8.2.2 BioAPI_GetBIRFromHandle 8.2.3 BioAPI_GetHeaderFromHandle |
509 | 8.3 Callback and Event Operations 8.3.1 BioAPI_EnableEvents |
510 | 8.3.2 BioAPI_SetGUICallbacks (BioAPI 2.0) 8.3.3 BioAPI_NotifyGUIProgressEvent (BioAPI 2.1) |
511 | 8.3.4 BioAPI_NotifyGUISelectEvent (BioAPI 2.1) |
512 | 8.3.5 BioAPI_NotifyGUIStateEvent (BioAPI 2.1) |
514 | 8.3.6 BioAPI_QueryGUIEventSubscriptions (BioAPI 2.1) |
515 | 8.3.7 BioAPI_RedirectGUIEvents (BioAPI 2.1) |
517 | 8.3.8 BioAPI_SubscribeToGUIEvents (BioAPI 2.1) |
519 | 8.3.9 BioAPI_UnredirectGUIEvents (BioAPI 2.1) 8.3.10 BioAPI_UnsubscribeFromGUIEvents (BioAPI 2.1) |
520 | 8.3.11 BioAPI_EnableEventNotifications (BioAPI 2.1) |
521 | 8.4 Biometric Operations 8.4.1 BioAPI_Capture |
523 | 8.4.2 BioAPI_CreateTemplate |
524 | 8.4.3 BioAPI_Process |
525 | 8.4.4 BioAPI_ProcessWithAuxBIR (BioAPI2.0 and BioAPI2.1) |
526 | 8.4.5 BioAPI_ProcessUsingAuxBIRs (BioAPI 2.2) |
528 | 8.4.6 BioAPI_VerifyMatch |
530 | 8.4.7 BioAPI_VerifyMatchUsingAuxBIRs (BioAPI 2.2) |
532 | 8.4.8 BioAPI_IdentifyMatch |
534 | 8.4.9 BioAPI_Decide (BioAPI 2.2) |
536 | 8.4.10 BioAPI_Fuse (BioAPI 2.2) |
537 | 8.4.11 BioAPI_Enroll |
539 | 8.4.12 BioAPI_Verify |
541 | 8.4.13 BioAPI_Identify |
544 | 8.4.14 BioAPI_Import |
545 | 8.4.15 BioAPI_Export (BioAPI 2.2) |
546 | 8.4.16 BioAPI_PresetIdentifyPopulation 8.5 Database Operations 8.5.1 BioAPI_DbOpen |
547 | 8.5.2 BioAPI_DbClose |
548 | 8.5.3 BioAPI_DbCreate |
549 | 8.5.4 BioAPI_DbDelete 8.5.5 BioAPI_DbSetMarker |
550 | 8.5.6 BioAPI_DbFreeMarker 8.5.7 BioAPI_DbStoreBIR |
551 | 8.5.8 BioAPI_DbGetBIR |
552 | 8.5.9 BioAPI_DbGetNextBIR |
553 | 8.5.10 BioAPI_DbDeleteBIR |
554 | 8.6 BioAPI Unit operations 8.6.1 BioAPI_SetPowerMode |
555 | 8.6.2 BioAPI_SetIndicatorStatus 8.6.3 BioAPI_GetIndicatorStatus |
556 | 8.6.4 BioAPI_CalibrateSensor 8.7 Utility Functions 8.7.1 BioAPI_Cancel |
557 | 8.7.2 BioAPI_Free |
558 | 9 BioAPI Service Provider Interface 9.1 Summary 9.2 Type Definitions for Biometric Service Providers 9.2.1 BioSPI_EventHandler |
559 | 9.2.2 BioSPI_BFP_ENUMERATION_HANDLER |
560 | 9.2.3 BioSPI_MEMORY_FREE_HANDLER 9.2.4 BioSPI_GUI_PROGRESS_EVENT_HANDLER (BioAPI 2.1) |
561 | 9.2.5 BioSPI_GUI_SELECT_EVENT_HANDLER (BioAPI 2.1) |
562 | 9.2.6 BioSPI_GUI_STATE_EVENT_HANDLER (BioAPI 2.1) |
563 | 9.3 Biometric Service Provider Operations 9.3.1 SPI Component Management Operations |
568 | 9.3.2 SPI Data Handle Operations |
569 | 9.3.3 SPI Callback and Event Operations |
570 | 9.3.4 SPI Biometric Operations |
574 | 9.3.5 SPI Database Operations |
575 | 9.3.6 SPI BioAPI Unit operations |
576 | 9.3.7 SPI Utility Functions 10 Component registry interface |
577 | 10.1 BioAPI Registry Schema 10.1.1 Framework Schema 10.1.2 BSP Schema |
579 | 10.1.3 BFP Schema |
580 | 10.2 Component registry functions 10.2.1 BioAPI_Util_InstallBSP |
581 | 10.2.2 BioAPI_Util_InstallBFP 10.2.3 BioAPI_RegisterBSP (BioAPI 2.1) |
582 | 10.2.4 BioAPI_UnregisterBSP (BioAPI 2.1) |
583 | 10.2.5 ioAPI_RegisterBFP (BioAPI 2.1) |
584 | 10.2.6 BioAPI_UnregisterBFP (BioAPI 2.1) 10.2.7 BioAPI_GetLastErrorInfo (BioAPI 2.1) |
585 | 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 |
587 | 11.2.4 Component Management Error Codes |
588 | 11.2.5 Database Error Values 11.2.6 Location Error Values |
590 | 11.2.7 Quality Error Codes |
591 | 11.2.8 Security Error Codes (BioAPI 2.2) |
593 | Annex A (normative) Conformance |
610 | Annex B (normative) CBEFF Patron Format Specification: BioAPI patron format |
616 | Annex C (informative) Specification overview |
640 | Annex D (informative) Calling sequence examples and sample code |
658 | Annex E (normative) ASN.1 specification of BioAPI_BIR (BioAPI2.2) |
660 | Bibliography |