@microblink/blinkid-react-native 7.7.0 → 8001.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/BlinkidReactNative.podspec +2 -1
  2. package/README.md +621 -281
  3. package/android/build.gradle +56 -4
  4. package/android/gradle.properties +3 -4
  5. package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdClassInfoIdMappings.kt +33 -0
  6. package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdDeserializationUtilities.kt +370 -258
  7. package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdSerializationUtilities.kt +149 -41
  8. package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkidReactNativeModule.kt +54 -31
  9. package/ios/BlinkidReactNative.mm +49 -52
  10. package/ios/BlinkidReactNativeModule.swift +114 -57
  11. package/ios/Frameworks/BlinkID.xcframework/Info.plist +5 -9
  12. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/BlinkID +0 -0
  13. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Headers/BlinkID.h +893 -13
  14. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Info.plist +0 -0
  15. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64.swiftdoc +0 -0
  16. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/{arm64-apple-ios.private.swiftinterface → arm64.swiftinterface} +2421 -2076
  17. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/module.modulemap +1 -7
  18. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/PrivacyInfo.xcprivacy +0 -0
  19. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/BlinkID +0 -0
  20. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Headers/BlinkID.h +893 -13
  21. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Info.plist +0 -0
  22. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64.swiftdoc +0 -0
  23. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/{arm64-apple-ios-simulator.swiftinterface → arm64.swiftinterface} +2421 -2076
  24. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64.swiftdoc +0 -0
  25. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/{x86_64-apple-ios-simulator.private.swiftinterface → x86_64.swiftinterface} +2421 -2076
  26. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/module.modulemap +1 -7
  27. package/ios/Frameworks/BlinkIDUX.xcframework/Info.plist +5 -5
  28. package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeDirectory +0 -0
  29. package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeResources +276 -276
  30. package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeSignature +0 -0
  31. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX +0 -0
  32. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Assets.car +0 -0
  33. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Info.plist +0 -0
  34. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ak.lproj/Localizable.strings +0 -0
  35. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/am.lproj/Localizable.strings +0 -0
  36. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ar.lproj/Localizable.strings +0 -0
  37. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/bn.lproj/Localizable.strings +0 -0
  38. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/cs.lproj/Localizable.strings +0 -0
  39. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/da.lproj/Localizable.strings +0 -0
  40. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/de.lproj/Localizable.strings +0 -0
  41. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/el.lproj/Localizable.strings +0 -0
  42. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/en-GB.lproj/Localizable.strings +0 -0
  43. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/en.lproj/Localizable.strings +0 -0
  44. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/es-MX.lproj/Localizable.strings +0 -0
  45. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/es.lproj/Localizable.strings +0 -0
  46. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fa.lproj/Localizable.strings +0 -0
  47. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fi.lproj/Localizable.strings +0 -0
  48. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fil.lproj/Localizable.strings +0 -0
  49. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fr-CA.lproj/Localizable.strings +0 -0
  50. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fr.lproj/Localizable.strings +0 -0
  51. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ha.lproj/Localizable.strings +0 -0
  52. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/he.lproj/Localizable.strings +0 -0
  53. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hi.lproj/Localizable.strings +0 -0
  54. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hr.lproj/Localizable.strings +0 -0
  55. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hu.lproj/Localizable.strings +0 -0
  56. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/id.lproj/Localizable.strings +0 -0
  57. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/is.lproj/Localizable.strings +0 -0
  58. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/it.lproj/Localizable.strings +0 -0
  59. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ja.lproj/Localizable.strings +0 -0
  60. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ka-GE.lproj/Localizable.strings +0 -0
  61. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/kk.lproj/Localizable.strings +0 -0
  62. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/km-KH.lproj/Localizable.strings +0 -0
  63. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ko.lproj/Localizable.strings +0 -0
  64. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/lv.lproj/Localizable.strings +0 -0
  65. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ms.lproj/Localizable.strings +0 -0
  66. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/nb.lproj/Localizable.strings +0 -0
  67. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ne.lproj/Localizable.strings +0 -0
  68. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/nl.lproj/Localizable.strings +0 -0
  69. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pl.lproj/Localizable.strings +0 -0
  70. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ps-AF.lproj/Localizable.strings +0 -0
  71. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pt-BR.lproj/Localizable.strings +0 -0
  72. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pt.lproj/Localizable.strings +0 -0
  73. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ro.lproj/Localizable.strings +0 -0
  74. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ru.lproj/Localizable.strings +0 -0
  75. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/si.lproj/Localizable.strings +0 -0
  76. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sk.lproj/Localizable.strings +0 -0
  77. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sl.lproj/Localizable.strings +0 -0
  78. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sr.lproj/Localizable.strings +0 -0
  79. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sv.lproj/Localizable.strings +0 -0
  80. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sw.lproj/Localizable.strings +0 -0
  81. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/th.lproj/Localizable.strings +0 -0
  82. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/tr.lproj/Localizable.strings +0 -0
  83. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/uk.lproj/Localizable.strings +0 -0
  84. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ur.lproj/Localizable.strings +0 -0
  85. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/uz.lproj/Localizable.strings +0 -0
  86. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/vi.lproj/Localizable.strings +0 -0
  87. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/yo.lproj/Localizable.strings +0 -0
  88. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/zh-Hans.lproj/Localizable.strings +0 -0
  89. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/zh-Hant.lproj/Localizable.strings +0 -0
  90. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Info.plist +0 -0
  91. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.abi.json +3860 -1881
  92. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.package.swiftinterface +87 -69
  93. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.private.swiftinterface +87 -69
  94. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
  95. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.swiftinterface +87 -69
  96. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX +0 -0
  97. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Assets.car +0 -0
  98. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Info.plist +0 -0
  99. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/_CodeSignature/CodeDirectory +0 -0
  100. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/_CodeSignature/CodeResources +114 -114
  101. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ak.lproj/Localizable.strings +0 -0
  102. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/am.lproj/Localizable.strings +0 -0
  103. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ar.lproj/Localizable.strings +0 -0
  104. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/bn.lproj/Localizable.strings +0 -0
  105. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/cs.lproj/Localizable.strings +0 -0
  106. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/da.lproj/Localizable.strings +0 -0
  107. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/de.lproj/Localizable.strings +0 -0
  108. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/el.lproj/Localizable.strings +0 -0
  109. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/en-GB.lproj/Localizable.strings +0 -0
  110. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/en.lproj/Localizable.strings +0 -0
  111. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/es-MX.lproj/Localizable.strings +0 -0
  112. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/es.lproj/Localizable.strings +0 -0
  113. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fa.lproj/Localizable.strings +0 -0
  114. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fi.lproj/Localizable.strings +0 -0
  115. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fil.lproj/Localizable.strings +0 -0
  116. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fr-CA.lproj/Localizable.strings +0 -0
  117. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/fr.lproj/Localizable.strings +0 -0
  118. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ha.lproj/Localizable.strings +0 -0
  119. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/he.lproj/Localizable.strings +0 -0
  120. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hi.lproj/Localizable.strings +0 -0
  121. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hr.lproj/Localizable.strings +0 -0
  122. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hu.lproj/Localizable.strings +0 -0
  123. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/id.lproj/Localizable.strings +0 -0
  124. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/is.lproj/Localizable.strings +0 -0
  125. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/it.lproj/Localizable.strings +0 -0
  126. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ja.lproj/Localizable.strings +0 -0
  127. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ka-GE.lproj/Localizable.strings +0 -0
  128. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/kk.lproj/Localizable.strings +0 -0
  129. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/km-KH.lproj/Localizable.strings +0 -0
  130. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ko.lproj/Localizable.strings +0 -0
  131. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/lv.lproj/Localizable.strings +0 -0
  132. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ms.lproj/Localizable.strings +0 -0
  133. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/nb.lproj/Localizable.strings +0 -0
  134. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ne.lproj/Localizable.strings +0 -0
  135. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/nl.lproj/Localizable.strings +0 -0
  136. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pl.lproj/Localizable.strings +0 -0
  137. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ps-AF.lproj/Localizable.strings +0 -0
  138. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pt-BR.lproj/Localizable.strings +0 -0
  139. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/pt.lproj/Localizable.strings +0 -0
  140. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ro.lproj/Localizable.strings +0 -0
  141. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ru.lproj/Localizable.strings +0 -0
  142. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/si.lproj/Localizable.strings +0 -0
  143. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sk.lproj/Localizable.strings +0 -0
  144. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sl.lproj/Localizable.strings +0 -0
  145. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sr.lproj/Localizable.strings +0 -0
  146. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sv.lproj/Localizable.strings +0 -0
  147. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/sw.lproj/Localizable.strings +0 -0
  148. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/th.lproj/Localizable.strings +0 -0
  149. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/tr.lproj/Localizable.strings +0 -0
  150. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/uk.lproj/Localizable.strings +0 -0
  151. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/ur.lproj/Localizable.strings +0 -0
  152. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/uz.lproj/Localizable.strings +0 -0
  153. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/vi.lproj/Localizable.strings +0 -0
  154. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/yo.lproj/Localizable.strings +0 -0
  155. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/zh-Hans.lproj/Localizable.strings +0 -0
  156. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/zh-Hant.lproj/Localizable.strings +0 -0
  157. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Info.plist +0 -0
  158. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.abi.json +3860 -1881
  159. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.package.swiftinterface +87 -69
  160. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +87 -69
  161. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
  162. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.swiftinterface +87 -69
  163. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.abi.json +3860 -1881
  164. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.package.swiftinterface +87 -69
  165. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +87 -69
  166. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
  167. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +87 -69
  168. package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/_CodeSignature/CodeResources +1 -1
  169. package/ios/Serialization/BlinkIdDeserializationUtils.swift +614 -0
  170. package/ios/{BlinkIdSerializationUtilities.swift → Serialization/BlinkIdSerializationUtils.swift} +294 -255
  171. package/lib/module/NativeBlinkidReactNative.js.map +1 -1
  172. package/lib/module/blinkIdResult.js +1 -822
  173. package/lib/module/blinkIdResult.js.map +1 -1
  174. package/lib/module/blinkIdSettings.js +1 -496
  175. package/lib/module/blinkIdSettings.js.map +1 -1
  176. package/lib/module/index.js +94 -17
  177. package/lib/module/index.js.map +1 -1
  178. package/lib/module/types.js +715 -3373
  179. package/lib/module/types.js.map +1 -1
  180. package/lib/typescript/src/NativeBlinkidReactNative.d.ts +36 -5
  181. package/lib/typescript/src/NativeBlinkidReactNative.d.ts.map +1 -1
  182. package/lib/typescript/src/blinkIdResult.d.ts +17 -20
  183. package/lib/typescript/src/blinkIdResult.d.ts.map +1 -1
  184. package/lib/typescript/src/blinkIdSettings.d.ts +195 -317
  185. package/lib/typescript/src/blinkIdSettings.d.ts.map +1 -1
  186. package/lib/typescript/src/index.d.ts +48 -10
  187. package/lib/typescript/src/index.d.ts.map +1 -1
  188. package/lib/typescript/src/types.d.ts +1062 -1210
  189. package/lib/typescript/src/types.d.ts.map +1 -1
  190. package/package.json +5 -4
  191. package/src/NativeBlinkidReactNative.ts +39 -5
  192. package/src/blinkIdResult.ts +19 -466
  193. package/src/blinkIdSettings.ts +218 -389
  194. package/src/index.tsx +221 -35
  195. package/src/types.ts +1253 -1463
  196. package/android/.gradle/8.9/checksums/checksums.lock +0 -0
  197. package/android/.gradle/8.9/checksums/md5-checksums.bin +0 -0
  198. package/android/.gradle/8.9/checksums/sha1-checksums.bin +0 -0
  199. package/android/.gradle/8.9/dependencies-accessors/gc.properties +0 -0
  200. package/android/.gradle/8.9/fileChanges/last-build.bin +0 -0
  201. package/android/.gradle/8.9/fileHashes/fileHashes.lock +0 -0
  202. package/android/.gradle/8.9/gc.properties +0 -0
  203. package/android/.gradle/buildOutputCleanup/buildOutputCleanup.lock +0 -0
  204. package/android/.gradle/buildOutputCleanup/cache.properties +0 -2
  205. package/android/.gradle/vcs-1/gc.properties +0 -0
  206. package/android/.project +0 -28
  207. package/ios/BlinkIdDeserializationUtilities.swift +0 -374
  208. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Headers/BlinkID-Swift.h +0 -43937
  209. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Headers/MBSampleBufferWrapper.h +0 -28
  210. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.abi.json +0 -78651
  211. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
  212. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.swiftinterface +0 -2304
  213. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/module.private.modulemap +0 -12
  214. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/PrivateHeaders/SwiftCxxBridge.hpp +0 -19
  215. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/_CodeSignature/CodeResources +0 -245
  216. package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/conan.xcconfig +0 -40
  217. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Headers/BlinkID-Swift.h +0 -87870
  218. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Headers/MBSampleBufferWrapper.h +0 -28
  219. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.abi.json +0 -78651
  220. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +0 -2304
  221. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
  222. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.abi.json +0 -78651
  223. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
  224. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +0 -2304
  225. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/module.private.modulemap +0 -12
  226. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/PrivateHeaders/SwiftCxxBridge.hpp +0 -19
  227. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/_CodeSignature/CodeResources +0 -300
  228. package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/conan.xcconfig +0 -40
  229. package/lib/module/blinkIdUtilities.js +0 -21
  230. package/lib/module/blinkIdUtilities.js.map +0 -1
  231. package/lib/typescript/src/blinkIdUtilities.d.ts +0 -8
  232. package/lib/typescript/src/blinkIdUtilities.d.ts.map +0 -1
  233. package/src/android/.project +0 -28
  234. package/src/blinkIdUtilities.ts +0 -20
package/src/types.ts CHANGED
@@ -1,15 +1,439 @@
1
- import { BlinkIdUtilities } from "./blinkIdUtilities";
1
+ /**
2
+ * Specifies whether the input image is already cropped, likely cropped, or not
3
+ * cropped.
4
+ *
5
+ * - `"not-cropped"`: The image is considered raw and goes through document
6
+ * detection and perspective correction.
7
+ * - `"unknown"`: The image may already be cropped. The recognizer first tries
8
+ * cropped processing and falls back to detection if extraction fails.
9
+ * - `"cropped"`: The input image must contain only the cropped and
10
+ * perspective-corrected document.
11
+ */
12
+ export type InputImageCropType = "not-cropped" | "unknown" | "cropped";
13
+
14
+ /**
15
+ * Controls how the best input image is selected from a pool of stable frames.
16
+ *
17
+ * Before the best-quality image is selected, a sequence of stable input images
18
+ * must be collected. An input image is considered stable when image analysis
19
+ * results are consistent across consecutive frames. A larger pool increases the
20
+ * likelihood of capturing a high-quality image but may introduce a slight delay.
21
+ *
22
+ * - `"single-image"`: Selects the first acceptable stable input image.
23
+ * - `"optimize-for-speed"`: Faster processing; may select a lower-quality image
24
+ * because a smaller pool of stable input images is considered.
25
+ * - `"balanced"`: Trade-off between quality and speed.
26
+ * - `"optimize-for-quality"`: Slower processing to select a high-quality input
27
+ * image because a larger pool of stable input images is considered.
28
+ *
29
+ * Applicable only to `Video` input sources.
30
+ */
31
+ export type InputImageSelectionStrategy =
32
+ | "single-image"
33
+ | "optimize-for-speed"
34
+ | "balanced"
35
+ | "optimize-for-quality";
36
+
37
+ /**
38
+ * Settings for the barcode extraction module.
39
+ *
40
+ * This module manages the detection and data extraction from various 1D and 2D
41
+ * barcode formats (such as PDF417, QR codes, and various retail codes).
42
+ *
43
+ * It can operate as a standalone module or in combination with document capture.
44
+ */
45
+ export type BarcodeModuleSettings = {
46
+ /*
47
+ * If set to true, barcode presence becomes mandatory for the scanned document.
48
+ * For [ScanningMode.single], the barcode must be present on the scanned side.
49
+ * For [ScanningMode.automatic], the barcode must be present on one of the scanned sides.
50
+ *
51
+ * In case of a timeout and advancement to the next step in the scanning flow,
52
+ * if a barcode is detected on the scanned side but cannot be extracted,
53
+ * the presence requirement is considered fulfilled. As a result, barcode extraction
54
+ * will no longer be a requirement to complete the scan on next side.
55
+ */
56
+ presenceMandatory: boolean;
57
+
58
+ /*
59
+ * Indicates whether the barcode image should be returned in the result.
60
+ *
61
+ * The DPI setting and the extension factor do not affect returned barcode image.
62
+ */
63
+ barcodeImageReturnEnabled: boolean;
64
+ /*
65
+ * Enables the scanning and processing of Pdf417 barcodes.
66
+ *
67
+ * The current analyzer model flags a barcode as "present" if either a `PDF417` or a `QR` code is detected.
68
+ * Because the model does not distinguish between the two types at this stage, a conflict can occur:
69
+ * if `PDF417` is enabled but `QR` is disabled, the analyzer may trigger for a `QR` code, causing the process to hang.
70
+ * To prevent this, `pdf417ScanningEnabled` and `qrScanningEnabled` must be enabled together.
71
+ */
72
+ pdf417ScanningEnabled: boolean;
73
+ /*
74
+ * Enables the scanning and processing of QR barcodes.
75
+ *
76
+ * The current analyzer model flags a barcode as "present" if either a `PDF417` or a `QR` code is detected.
77
+ * Because the model does not distinguish between the two types at this stage, a conflict can occur:
78
+ * if `PDF417` is enabled but `QR` is disabled, the analyzer may trigger for a `QR` code, causing the process to hang.
79
+ *
80
+ * To prevent this, `qrScanningEnabled` and `pdf417ScanningEnabled` must be enabled together.
81
+ */
82
+ qrScanningEnabled: boolean;
83
+
84
+ /*
85
+ * Enables the scanning and processing of UPC-E barcodes.
86
+ *
87
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
88
+ */
89
+ upceScanningEnabled: boolean;
90
+
91
+ /*
92
+ * Enables the scanning and processing of UPC-A barcodes.
93
+ *
94
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
95
+ */
96
+ upcaScanningEnabled: boolean;
97
+
98
+ /*
99
+ * Enables the scanning and processing of Code-128 barcodes.
100
+ *
101
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
102
+ */
103
+ code128ScanningEnabled: boolean;
104
+
105
+ /*
106
+ * Enables the scanning and processing of Code-39 barcodes.
107
+ *
108
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
109
+ */
110
+ code39ScanningEnabled: boolean;
111
+
112
+ /*
113
+ * Enables the scanning and processing of EAN-8 barcodes.
114
+ *
115
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
116
+ */
117
+ ean8ScanningEnabled: boolean;
118
+
119
+ /*
120
+ * Enables the scanning and processing of EAN-13 barcodes.
121
+ *
122
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
123
+ */
124
+ ean13ScanningEnabled: boolean;
125
+
126
+ /*
127
+ * Enables the scanning and processing of ITF barcodes.
128
+ *
129
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
130
+ */
131
+ itfScanningEnabled: boolean;
132
+
133
+ /*
134
+ * Enables the scanning and processing of DataMatrix barcodes.
135
+ *
136
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
137
+ */
138
+ dataMatrixScanningEnabled: boolean;
139
+
140
+ /*
141
+ * Enables the scanning and processing of Aztec barcodes.
142
+ *
143
+ * This setting can be enabled only if `documentCaptureEnabled` is disabled.
144
+ */
145
+ aztecScanningEnabled: boolean;
146
+ };
147
+
148
+ /*
149
+ * Settings for the document capture module.
150
+ *
151
+ * This module is responsible for the initial document detection, image extraction
152
+ * (such as face and document images), and image quality validation (blur, glare,
153
+ * and lighting checks).
154
+ */
155
+ export type DocumentCaptureModuleSettings = {
156
+ /*
157
+ * Specifies whether the input image is already cropped, likely cropped, or
158
+ * not cropped.
159
+ *
160
+ * When set to `"cropped"`, the input image must consist solely of the already
161
+ * cropped and corrected document.
162
+ *
163
+ * When set to `"unknown"`, the recognizer first attempts extraction as if the
164
+ * image is cropped, then falls back to the regular localization pipeline if
165
+ * extraction fails.
166
+ *
167
+ * `"cropped"` and `"unknown"` are applicable only to `Photo` sources and will
168
+ * cause a validation error for `Video`.
169
+ *
170
+ * Default value is `"not-cropped"`.
171
+ */
172
+ cropType: InputImageCropType;
173
+
174
+ /*
175
+ * Enables the scanning and processing of unsupported document types.
176
+ *
177
+ * A document is considered unsupported if its classification result is `OTHER`.
178
+ */
179
+ unsupportedDocumentsAllowed: boolean;
180
+
181
+ /*
182
+ * Indicates whether the back side scan should be skipped if the document supports only image capture on that side.
183
+ *
184
+ * Some documents have a back side that is supported but contains no extractable data (no MRZ, Barcode, etc.).
185
+ * These sides will be "captured only".
186
+ *
187
+ * If set to `true` (default), the scanning process will stop after the front side for such documents.
188
+ * If set to `false`, the back side will be captured, even though no data extraction is performed.
189
+ */
190
+ secondSideWithNoExtractableDataSkipped: boolean;
191
+
192
+ /*
193
+ * Indicates whether only the passport data page should be scanned.
194
+ *
195
+ * Scan only the data page (page containing `MRZ`) of the passport.
196
+ *
197
+ * If set to `false`, it will be required to scan the second page of certain passports.
198
+ */
199
+ passportDataPageScanOnly: boolean;
200
+
201
+ /*
202
+ * Enables the extraction of the document's face image.
203
+ *
204
+ * If a face image is present on the document, extraction becomes mandatory if supported.
205
+ *
206
+ * For supported documents, the requirement for its presence is determined by document rules.
207
+ * For unsupported documents, presence is optional.
208
+ */
209
+ faceImageExtractionEnabled: boolean;
210
+
211
+ /*
212
+ * If set to `true`, face image presence will be mandatory for the scanned document.
213
+ *
214
+ * For [ScanningMode.automatic], document side with the face image must be scanned first.
215
+ *
216
+ * In case of a timeout and advancement to the next step in the scanning flow,
217
+ * if a face image is detected on the scanned side but cannot be extracted,
218
+ * the presence requirement is considered fulfilled. As a result, face image extraction
219
+ * will no longer be required to complete the scan on the next side.
220
+ */
221
+ faceImagePresenceMandatory: boolean;
222
+
223
+ /*
224
+ * Indicates whether input images should be returned in the result.
225
+ *
226
+ * Saves the input images at the moment of data extraction or timeout.
227
+ * This significantly increases memory consumption. Scanning performance is not affected.
228
+ */
229
+ inputImageReturnEnabled: boolean;
230
+
231
+ /*
232
+ * Indicates whether the cropped document image should be returned in the result.
233
+ *
234
+ */
235
+ documentImageReturnEnabled: boolean;
236
+
237
+ /*
238
+ * Defines the minimum required margin (in percentage) between the edge of the input image and the document.
239
+ *
240
+ * This setting is implemented to comply with regulations in certain countries that mandate documents
241
+ * to be stored with adequate margins in the image.
242
+ *
243
+ * Default value is `0.02`.
244
+ * The setting is applicable only when using images from `video` source.
245
+ *
246
+ * Allowed minimal value is `0.0` and maximum value is `1.0`.
247
+ */
248
+ inputImageMargin?: number;
249
+
250
+ /*
251
+ * The DPI value for the cropped document, face and signature image.
252
+ *
253
+ * Allowed minimal value is `100` and maximum value is `400`.
254
+ */
255
+ dotsPerInch: number;
256
+
257
+ /*
258
+ * The extension factor for the cropped document image. Applicable only to document images.
259
+ * Allowed minimal value is `0.0` and maximum value is `1.0`.
260
+ *
261
+ */
262
+ extensionFactor: number;
263
+
264
+ /*
265
+ * The sensitivity of blur detection in the document image.
266
+ *
267
+ * Defines the severity of blur detected in the document image.
268
+ *
269
+ * Low – less sensitive to blur; if something is detected as blur, it is almost certainly actual blur,
270
+ * but some amount of blur may not be detected.
271
+ *
272
+ * High – highly sensitive to blur; it may detect blur even if it only resembles blur.
273
+ *
274
+ * See {@link SensitivityLevel} for more information
275
+ */
276
+ blurSensitivityLevel: SensitivityLevel;
277
+
278
+ /*
279
+ * Indicates whether images with detected blur should be rejected.
280
+ *
281
+ * If `true`, images with detected blur will be excluded from further processing.
282
+ *
283
+ * If `false`, images will still be processed and blur status will be reported in the result.
284
+ */
285
+ imageWithBlurRejected: boolean;
286
+
287
+ /*
288
+ * The sensitivity of glare detection in the document image.
289
+ *
290
+ * Low – less sensitive to glare.
291
+ * High – highly sensitive to glare.
292
+ * See {@link SensitivityLevel} for more information
293
+ */
294
+ glareSensitivityLevel: SensitivityLevel;
295
+
296
+ /*
297
+ * Indicates whether images with detected glare should be rejected.
298
+ *
299
+ * If `true`, images with detected glare will be excluded from further processing.
300
+ *
301
+ * If `false`, images will still be processed and glare status will be reported in the result.
302
+ */
303
+ imageWithGlareRejected: boolean;
304
+
305
+ /*
306
+ * The sensitivity of allowed detected tilt of the document in the image.
307
+ *
308
+ * Low – less sensitive to tilt.
309
+ * High – highly sensitive to tilt.
310
+ * See {@link SensitivityLevel} for more information
311
+ */
312
+ tiltSensitivityLevel: SensitivityLevel;
313
+
314
+ /*
315
+ * Indicates whether images with poor lighting conditions should be rejected.
316
+ *
317
+ * Poor lighting conditions are represented as either `tooBright` or `tooDark`.
318
+ *
319
+ * If `true`, such images will be excluded from further processing.
320
+ */
321
+ imageWithPoorLightingRejected: boolean;
322
+
323
+ /*
324
+ * Indicates whether images occluded by a hand should be rejected.
325
+ *
326
+ * If `true`, occluded images will be excluded from further processing.
327
+ *
328
+ * Default behavior depends on `cropType`:
329
+ * - `Cropped`: Defaults to `false`. This setting is not applicable when
330
+ * the detector is skipped. Setting this to `true` while `cropType` is
331
+ * `Cropped` will result in a settings validation failure.
332
+ * - `NotCropped` / `Unknown`: Defaults to `true`. Images with hand
333
+ * occlusion are rejected.
334
+ */
335
+ imageWithHandOcclusionRejected: boolean;
336
+
337
+ /*
338
+ * The strategy used to select the best input image from a pool of stable
339
+ * input images.
340
+ *
341
+ * Default value is `"balanced"`.
342
+ * Applicable only to `Video` input sources.
343
+ */
344
+ inputImageSelectionStrategy: InputImageSelectionStrategy;
345
+ };
346
+
347
+ /*
348
+ * Settings for the MRZ (Machine Readable Zone) extraction module.
349
+ *
350
+ * This module is dedicated to the detection and parsing of machine-readable
351
+ * zone typically found on passports, visas, and identity cards.
352
+ */
353
+ export type MrzModuleSettings = {
354
+ /*
355
+ * If set to `true`, MRZ presence becomes mandatory for the scanned document
356
+ * regardless of the document rules.
357
+ *
358
+ * For [ScanningMode.single], the MRZ must be present on the scanned side.
359
+ * For [ScanningMode.automatic], the MRZ must be present on one of the scanned sides.
360
+ *
361
+ * In case of a timeout and advancement to the next step in the scanning flow,
362
+ * if an MRZ is detected on the scanned side but cannot be extracted,
363
+ * the presence requirement is considered fulfilled. As a result, MRZ extraction
364
+ * will no longer be required to complete the scan on the next side.
365
+ */
366
+ presenceMandatory: boolean;
367
+ };
368
+
369
+ /*
370
+ * Settings for the VIZ (Visual Inspection Zone) extraction module.
371
+ *
372
+ * This module is responsible for extracting data from the document's
373
+ * visual fields.
374
+ *
375
+ * It supports features such as character validation for increased accuracy,
376
+ * signature image extraction, and data aggregation across multiple video frames.
377
+ */
378
+ export type VizModuleSettings = {
379
+ /*
380
+ * If set to true, Viz presence becomes mandatory for the scanned document.
381
+ *
382
+ * For {@link ScanningMode.single}, the Viz must be present on the scanned side.
383
+ * Only the front side of supported documents can be scanned.
384
+ *
385
+ * For {@link ScanningMode.automatic}, this setting won't affect the default behaviour;
386
+ * front side must be scanned first followed by the back side.
387
+ *
388
+ * In case of a timeout and advancement to the next step in the scanning flow,
389
+ * if a Viz was not extracted fully from a front side, we'll proceed to extract Viz
390
+ * from the back side, if present.
391
+ */
392
+ presenceMandatory: boolean;
393
+
394
+ /*
395
+ * Enables the extraction of the document's signature image if supported.
396
+ *
397
+ * For supported documents, signature image extraction is determined by document rules.
398
+ * For unsupported documents, extraction won't be performed.
399
+ */
400
+ signatureImageExtractionEnabled: boolean;
401
+
402
+ /*
403
+ * Indicates whether character validation is enabled.
404
+ *
405
+ * Allow only results containing expected characters for a given field.
406
+ * Each field is validated against a set of rules.
407
+ * All fields have to be successfully validated in order to successfully scan a document.
408
+ * Setting is used to improve scanning accuracy.
409
+ */
410
+ characterValidationEnabled: boolean;
411
+
412
+ /*
413
+ * Indicates whether the aggregation of data from multiple input images is enabled.
414
+ *
415
+ * Disabling this setting will yield higher-quality captured images, but it may slow down the scanning process due to the additional
416
+ * effort required to find the optimal image.
417
+ *
418
+ * Enabling this setting will simplify the extraction process, but the extracted data will be aggregated from multiple images instead
419
+ * of being sourced from a single image.
420
+ *
421
+ * This only applies to images from `Video` input image source - for images from `Photo` source, setting will be ignored.
422
+ */
423
+ resultAggregationEnabled: boolean;
424
+ };
2
425
 
3
426
  /**
4
427
  * ClassFilter represents the document filter used to determine which documents will be processed.
5
- * Document information (Country, Region, Type) is evaluated with the content set in the filter, and their inclusion or exclusion depends on the defined rules.
428
+ * Document information ({@link CountryID}, {@link RegionID}, {@link DocumentTypeID}) is evaluated
429
+ * with the content set in the filter, and their inclusion or exclusion depends on the defined rules.
6
430
  * To set the document information, use {@link DocumentFilter}.
7
431
  * The recognition results of the excluded documents will not be returned.
8
432
  * If using the standard BlinkID UX, an alert will be displayed that the document will not be scanned.
9
433
  *
10
434
  * By default, the ClassFilter is turned off, and all documents will be included.
11
435
  */
12
- export class ClassFilter {
436
+ export type ClassFilter = {
13
437
  /**
14
438
  * Document classes that will be explicitly accepted by this filter.
15
439
  * Only documents belonging to the specified classes will be processed. All other documents will be rejected.
@@ -18,16 +442,14 @@ export class ClassFilter {
18
442
  *
19
443
  * Example usage:
20
444
  *
21
- * ```
22
- * final classFilter = ClassFilter();
23
- * classFilter.includeDocuments = [
24
- * DocumentFilter.country(Country.Usa),
25
- * DocumentFilter.countryType(Country.Croatia, DocumentType.Id),
26
- * ];
27
- *
28
- *
29
- * ```
30
- *
445
+ * ```ts
446
+ * const classFilter: ClassFilter = {
447
+ * includeDocuments: [
448
+ * { country: CountryID.USA },
449
+ * { country: CountryID.Croatia, documentType: DocumentTypeID.Id },
450
+ * ],
451
+ * };
452
+ * ```
31
453
  *
32
454
  * NOTE: from the example above, the class filter is set to only accept all documents from USA, and Croatian IDs.
33
455
  * All other documents will be rejected.
@@ -45,142 +467,82 @@ export class ClassFilter {
45
467
  *
46
468
  * Example usage:
47
469
  *
48
- * ```
49
- * final classFilter = ClassFilter();
50
- * classFilter.excludeDocuments = [
51
- * DocumentFilter.country(Country.Usa),
52
- * DocumentFilter.countryType(Country.Croatia, DocumentType.Id),
53
- * ];
54
- *
55
- *
56
- * ```
470
+ * ```ts
471
+ * const classFilter: ClassFilter = {
472
+ * excludeDocuments: [
473
+ * { country: CountryID.USA },
474
+ * { country: CountryID.Croatia, documentType: DocumentTypeID.Id },
475
+ * ],
476
+ * };
477
+ * ```
57
478
  *
58
479
  * NOTE: from the example above, the class filter is set to only exclude all documents from USA, and Croatian IDs.
59
480
  * All other classes will be accepted.
60
481
  *
61
- * Rules can be combined, for example, to set all three properties (Country Region, Type), two (e.g., Country and Type) or just one (e.g, Region).
482
+ * Rules can be combined, for example, to set all three properties (country, region, documentType),
483
+ * two (e.g. country and documentType) or just one (e.g. region).
62
484
  *
63
485
  * See {@link DocumentFilter} for setting the combinations.
64
486
  */
65
487
  excludeDocuments?: DocumentFilter[];
488
+ };
66
489
 
67
- /**
68
- *
69
- * @param includeDocuments - specifies which document classes that will be explicitly accepted by this filter.
70
- * @param excludeDocuments - specifies which document classes that will be explicitly rejected by this filter.
71
- */
72
- constructor(
73
- includeDocuments?: DocumentFilter[],
74
- excludeDocuments?: DocumentFilter[],
75
- ) {
76
- this.includeDocuments = includeDocuments;
77
- this.excludeDocuments = excludeDocuments;
78
- }
79
- }
80
-
81
- /**
82
- * Represents the document filter.
490
+ /*
491
+ * A resolver that provides custom [RedactionSettings] for a scanned document
492
+ * based on its detected class information.
493
+ *
494
+ * Add the resolver when you need per-document redaction behavior — for example,
495
+ * anonymizing different fields depending on the document's country or type. The resolver
496
+ * is invoked by the SDK immediately before the scanning result is finalized.
83
497
  *
84
- * Used with other classes like the {@link ClassFilter}, {@link DocumentRules} and the {@link DocumentAnonymizationSettings}.
498
+ * If not added, the SDK will use the default [RedactionSettings] for a given document class.
85
499
  */
86
- export class DocumentFilter {
87
- /**
88
- * If set, only specified country will pass the filter criteria.
89
- * Otherwise, issuing country will not betaken into account.
90
- */
91
- country?: Country;
92
-
93
- /**
94
- * If set, only specified country will pass the filter criteria.
95
- * Otherwise, issuing region will not be taken into account.
96
- */
97
- region?: Region;
98
-
99
- /**
100
- * If set, only specified type will pass the filter criteria.
101
- * Otherwise, issuing type will not be taken into account.
102
- */
103
- documentType?: DocumentType;
104
-
105
- /**
106
- *
107
- * @param country - specifies the {@link Country} that will pass the filter criteria.
108
- *
109
- * @param region - specifies the {@link Region} that will pass the filter criteria.
500
+ export type RedactionSettingsResolver = {
501
+ /*
502
+ * A list of redaction configurations evaluated by the SDK.
110
503
  *
111
- * @param documentType - specifies the {@link DocumentType} that will pass the filter criteria.
504
+ * Each [RedactionSettings] entry can target specific document classes
505
+ * using [RedactionSettings.documentFilter].
112
506
  *
507
+ * During scanning, the SDK selects the first matching configuration
508
+ * for the detected document class and applies its redaction rules.
113
509
  *
114
- * All parameters are optional, and do not need to be added.
115
- * The filter can be set to be more generic (for example, to only accept document from USA):
116
- * ```
117
- * DocumentFilter(Country.Usa);
118
- * ```
119
- * or, it can be set to be more specific (for example, to specifically accept USA drivers licenses from California):
120
- * ```
121
- * DocumentFilter(Country.Usa, Region.California, DocumentType.Dl);
122
- * ```
510
+ * If no matching configuration is found, the default SDK redaction
511
+ * behavior is used.
123
512
  */
124
- constructor(country?: Country, region?: Region, documentType?: DocumentType) {
125
- this.country = country;
126
- this.region = region;
127
- this.documentType = documentType;
128
- }
129
- }
513
+ documentRedactionList: RedactionSettings[];
514
+ };
130
515
 
131
516
  /**
132
- * Represents the custom document rules.
133
- *
134
- * This setting allows users to narrow down our internal rules on mandatory fields. All undefined fields will become optional.
135
- * It is not possible to mark fields as mandatory if they cannot theoretically appear on the document.
136
- * The more detailed document filter will have priority over the other.
517
+ * Represents the document filter.
137
518
  *
138
- * Document fields are validated using internal rules that define mandatory fields for the scanned document class.
519
+ * Used with other classes like the {@link ClassFilter}, {@link DocumentRules} and the {@link RedactionSettings}.
139
520
  */
140
- export class DocumentRules {
521
+ export type DocumentFilter = {
141
522
  /**
142
- * Specified fields will overrule our document class field rules if filter conditions are met.
523
+ * If set, only the specified country will pass the filter criteria.
524
+ * Otherwise, issuing country will not be taken into account.
143
525
  *
144
- * See {@link DocumentFilter} for more information.
526
+ * See {@link CountryID}.
145
527
  */
146
- documentFilter?: DocumentFilter;
528
+ country?: CountryID;
147
529
 
148
530
  /**
149
- * Fields to overrule our class field rules.
531
+ * If set, only specified country will pass the filter criteria.
532
+ * Otherwise, issuing region will not be taken into account.
150
533
  *
151
- * See {@link DetailedFieldType} for more information.
534
+ * See {@link RegionID}.
152
535
  */
153
- fields: DetailedFieldType[];
536
+ region?: RegionID;
154
537
 
155
538
  /**
156
- * Represents the custom document rules.
157
- *
158
- * This setting allows users to narrow down our internal rules on mandatory fields. All undefined fields will become optional.
159
- * It is not possible to mark fields as mandatory if they cannot theoretically appear on the document.
160
- * The more detailed document filter will have priority over the other.
161
- *
162
- * Document fields are validated using internal rules that define mandatory fields for the scanned document class.
163
- * Defines custom rules for specific document class.
539
+ * If set, only the specified document type will pass the filter criteria.
540
+ * Otherwise, document type will not be taken into account.
164
541
  *
165
- * When defining {@link DocumentRules}, the {@link DocumentFilter} paramter is optionally set to specify the document to which the rule applies, and a `fields` with
166
- * the appropriate `alphabetType` should be specified as mandatory for that document.
167
- * If a `fields` is set to a field that is optional for that document or does not exist on it, all fields on the document become optional.
168
- * If a `fields` is set to a field with an incorrect alphabetType, all fields on the document become optional.
169
- * If a `fields` is set to a field that doesn’t exist in the internal rules, that rule is ignored.
170
- * When adding multiple `fields`, any field that does not match our rules is ignored. Only fields that comply with our rules are set as mandatory.
171
- * If the documentFilter fields `country`, `region`, or `type` are set to `null`, all supported values for those fields will be considered.
172
- * For example, if `country = null`, the rule will apply to all supported countries in BlinkID.
173
- *
174
- * @param fields - specifies the list of {@link DetailedFieldType} for overruling our class field rules.
175
- * This parameter is mandatory.
176
- * @param documentFilter - specifies the {@link DocumentFilter} to specify the document to which the rule applies.
177
- * This parameter is optional.
542
+ * See {@link DocumentTypeID}.
178
543
  */
179
- constructor(fields: DetailedFieldType[], documentFilter?: DocumentFilter) {
180
- this.fields = fields;
181
- this.documentFilter = documentFilter;
182
- }
183
- }
544
+ documentType?: DocumentTypeID;
545
+ };
184
546
 
185
547
  /**
186
548
  * Represents the detailed field type.
@@ -215,54 +577,47 @@ export class DetailedFieldType {
215
577
  }
216
578
 
217
579
  /**
218
- * Represents the document anonymization settings.
580
+ * Represents the document redaction settings.
219
581
  *
220
582
  */
221
- export class DocumentAnonymizationSettings {
583
+ export type RedactionSettings = {
222
584
  /**
223
- * Document fields that will be anonymized.
224
- *
585
+ * The mode of redaction applied to the document.
225
586
  */
226
- fields: FieldType[];
587
+ mode: RedactionMode;
227
588
 
228
589
  /**
229
- * Specified fields will be anonymized if filter conditions are met.
590
+ * Document fields that will be anonymized.
230
591
  *
231
592
  */
232
- documentFilter?: DocumentFilter;
593
+ fields: FieldType[];
233
594
 
234
595
  /**
235
596
  * Document number anonymization settings.
236
597
  *
237
598
  */
238
- documentNumberAnonymizationSettings?: DocumentNumberAnonymizationSettings;
599
+ documentNumberRedactionSettings?: DocumentNumberRedactionSettings;
239
600
 
240
- /**
241
- *
242
- * @param fields - specifies the document fields that will be anonymized. This parameter is mandatory.
243
- *
244
- * @param documentFilter - specifies the document filter.
601
+ /*
602
+ * If true, whole Mrz result will be redacted.
245
603
  *
246
- * If the conditions of the filter are met, fields of those documents will be anonymized.
247
- * This parameter is mandatory.
248
- * @param documentNumberAnonymizationSettings - specifies the document number anonymization settings.
604
+ * Default: `false`
605
+ */
606
+ redactMrzResult: boolean;
607
+
608
+ /*
609
+ * If true, whole Barcode result will be redacted.
249
610
  *
250
- * If this parameter is set, it will anonymize the document number, even if the document number is not set in the `fields` parameter.
251
- * If the default constructor for {@link DocumentNumberAnonymizationSettings} is used, all of the digits within the document number will be anonymized.
611
+ * Default: `false`
612
+ */
613
+ redactBarcodeResult: boolean;
614
+
615
+ /**
616
+ * Specified fields will be anonymized if filter conditions are met.
252
617
  *
253
- * This parameter is optional.
254
618
  */
255
- constructor(
256
- fields: FieldType[],
257
- documentFilter?: DocumentFilter,
258
- documentNumberAnonymizationSettings?: DocumentNumberAnonymizationSettings,
259
- ) {
260
- this.fields = fields;
261
- this.documentFilter = documentFilter;
262
- this.documentNumberAnonymizationSettings =
263
- documentNumberAnonymizationSettings;
264
- }
265
- }
619
+ documentFilter?: DocumentFilter;
620
+ };
266
621
 
267
622
  /**
268
623
  * Represents the document number anonymization settings.
@@ -274,7 +629,7 @@ export class DocumentAnonymizationSettings {
274
629
  *
275
630
  * If any parameter is `undefined`, the value of the parameter will be set to `0`.
276
631
  */
277
- export class DocumentNumberAnonymizationSettings {
632
+ export type DocumentNumberRedactionSettings = {
278
633
  /**
279
634
  * Defines how many digits at the beginning of the document number remain visible after anonymization.
280
635
  *
@@ -286,79 +641,53 @@ export class DocumentNumberAnonymizationSettings {
286
641
  *
287
642
  */
288
643
  suffixDigitsVisible?: number;
644
+ };
289
645
 
290
- constructor(
291
- prefixDigitsVisible: number = 0,
292
- suffixDigitsVisible: number = 0,
293
- ) {
294
- this.prefixDigitsVisible = prefixDigitsVisible;
295
- this.suffixDigitsVisible = suffixDigitsVisible;
296
- }
297
- }
298
646
  /**
299
- * Represents the configuration used to enable/disable recognition of specific
300
- * document groups.
647
+ * Document country classification from {@link DocumentClassInfo}.
301
648
  *
302
- * By default all modes are enabled.
649
+ * When the value is known at SDK build time, both {@link id} and {@link rawValue}
650
+ * are populated. For OTA-supported / unknown documents, {@link id} may be omitted
651
+ * while {@link rawValue} is still set. A missing country is represented by omitting
652
+ * {@link DocumentClassInfo.country} entirely (native `"NONE"`).
303
653
  */
304
- export class RecognitionModeFilter {
305
- /**
306
- * Enable scanning of MRZ IDs.
307
- *
308
- */
309
- enableMrzId: boolean;
654
+ export type Country = {
655
+ id?: CountryID;
656
+ rawValue: string;
657
+ };
310
658
 
311
- /**
312
- * Enable scanning of visa MRZ.
313
- *
314
- */
315
- enableMrzVisa: boolean;
316
-
317
- /**
318
- * Enable scanning of Passport MRZ.
319
- *
320
- */
321
- enableMrzPassport: boolean;
322
-
323
- /**
324
- * Enable scanning of Photo ID.
325
- *
326
- */
327
- enablePhotoId: boolean;
328
-
329
- /**
330
- * Enable scanning of barcode IDs.
331
- *
332
- */
333
- enableBarcodeId: boolean;
334
-
335
- /**
336
- * Enable full document recognition.
337
- *
338
- */
339
- enableFullDocumentRecognition: boolean;
659
+ /**
660
+ * Document region classification from {@link DocumentClassInfo}.
661
+ *
662
+ * See {@link Country} for how {@link id} vs {@link rawValue} are filled.
663
+ */
664
+ export type Region = {
665
+ id?: RegionID;
666
+ rawValue: string;
667
+ };
340
668
 
341
- constructor() {
342
- this.enableMrzId = true;
343
- this.enableMrzVisa = true;
344
- this.enableMrzPassport = true;
345
- this.enablePhotoId = true;
346
- this.enableBarcodeId = true;
347
- this.enableFullDocumentRecognition = true;
348
- }
349
- }
669
+ /**
670
+ * Document type classification from {@link DocumentClassInfo}.
671
+ *
672
+ * See {@link Country} for how {@link id} vs {@link rawValue} are filled.
673
+ */
674
+ export type DocumentType = {
675
+ id?: DocumentTypeID;
676
+ rawValue: string;
677
+ };
350
678
 
351
679
  /**
352
680
  * Represents the document class information.
353
681
  *
354
682
  */
355
- export class DocumentClassInfo {
683
+ export type DocumentClassInfo = {
356
684
  /**
357
685
  * The document country.
358
686
  *
359
687
  * See {@link Country} for more information.
360
688
  */
361
689
  country?: Country;
690
+
362
691
  /**
363
692
  * The document region.
364
693
  *
@@ -367,7 +696,7 @@ export class DocumentClassInfo {
367
696
  region?: Region;
368
697
 
369
698
  /**
370
- * The type of the scanned document.
699
+ * The document type classification.
371
700
  *
372
701
  * See {@link DocumentType} for more information.
373
702
  */
@@ -381,50 +710,30 @@ export class DocumentClassInfo {
381
710
 
382
711
  /**
383
712
  * The name of the country that issued the scanned document.
384
- *
385
713
  */
386
714
  countryName?: string;
387
715
 
388
716
  /**
389
717
  * The ISO numeric code of the country that issued the scanned document.
390
- *
391
718
  */
392
719
  isoNumericCountryCode?: string;
393
720
 
394
721
  /**
395
722
  * The 2 letter ISO code of the country that issued the scanned document.
396
- *
397
723
  */
398
724
  isoAlpha2CountryCode?: string;
399
725
 
400
726
  /**
401
727
  * The 3 letter ISO code of the country that issued the scanned document.
402
- *
403
728
  */
404
729
  isoAlpha3CountryCode?: string;
405
-
406
- /**
407
- *
408
- * @param nativeDocumentClassInfo
409
- *
410
- */
411
- constructor(nativeDocumentClassInfo: any) {
412
- this.country = nativeDocumentClassInfo.country;
413
- this.region = nativeDocumentClassInfo.region;
414
- this.documentType = nativeDocumentClassInfo.documentType;
415
- this.empty = nativeDocumentClassInfo.empty;
416
- this.countryName = nativeDocumentClassInfo.countryName;
417
- this.isoNumericCountryCode = nativeDocumentClassInfo.isoNumericCountryCode;
418
- this.isoAlpha2CountryCode = nativeDocumentClassInfo.isoAlpha2CountryCode;
419
- this.isoAlpha3CountryCode = nativeDocumentClassInfo.isoAlpha3CountryCode;
420
- }
421
- }
730
+ };
422
731
 
423
732
  /**
424
733
  * Represents the result of the data match.
425
734
  *
426
735
  */
427
- export class DataMatchResult {
736
+ export type DataMatchResult = {
428
737
  /**
429
738
  * The state of the data match on the whole document.
430
739
  *
@@ -438,25 +747,13 @@ export class DataMatchResult {
438
747
  * See {@link DataMatchResultField} for more information.
439
748
  */
440
749
  states?: DataMatchResultField[];
441
-
442
- /**
443
- *
444
- * @param nativeDataMatchResult
445
- */
446
- constructor(nativeDataMatchResult: any) {
447
- this.overallState =
448
- nativeDataMatchResult.overallState != undefined
449
- ? (nativeDataMatchResult.overallState as DataMatchState)
450
- : undefined;
451
- this.states = nativeDataMatchResult.states;
452
- }
453
- }
750
+ };
454
751
 
455
752
  /**
456
753
  * Represents the state of the field in the data match.
457
754
  *
458
755
  */
459
- export class DataMatchResultField {
756
+ export type DataMatchResultField = {
460
757
  /**
461
758
  * The type of the field.
462
759
  *
@@ -469,17 +766,7 @@ export class DataMatchResultField {
469
766
  * See {@link DataMatchState} for more information.
470
767
  */
471
768
  state?: DataMatchState;
472
-
473
- /**
474
- *
475
- * @param nativeDataMatchResultField
476
- *
477
- */
478
- constructor(nativeDataMatchResultField: any) {
479
- this.field = nativeDataMatchResultField.field;
480
- this.state = nativeDataMatchResultField.state;
481
- }
482
- }
769
+ };
483
770
 
484
771
  /**
485
772
  * Represents the multi-alphabet string result extracted from the OCR.
@@ -487,7 +774,7 @@ export class DataMatchResultField {
487
774
  * The result contains the extracted strings, their locations, and the sides of the extracted strings.
488
775
  *
489
776
  */
490
- export class StringResult {
777
+ export type StringResult = {
491
778
  /**
492
779
  * All strings separated by new line
493
780
  *
@@ -531,34 +818,13 @@ export class StringResult {
531
818
  * See {@link Side} for more information.
532
819
  */
533
820
  side?: Side;
534
-
535
- /**
536
- *
537
- * @param nativeStringResult
538
- *
539
- */
540
- constructor(nativeStringResult: any) {
541
- this.value = nativeStringResult.value;
542
- this.latin = nativeStringResult.latin;
543
- this.cyrillic = nativeStringResult.cyrillic;
544
- this.arabic = nativeStringResult.arabic;
545
- this.greek = nativeStringResult.greek;
546
- this.location =
547
- nativeStringResult.location != undefined
548
- ? new Location(nativeStringResult.location)
549
- : undefined;
550
- this.side =
551
- nativeStringResult.side != undefined
552
- ? new Side(nativeStringResult.side)
553
- : undefined;
554
- }
555
- }
821
+ };
556
822
 
557
823
  /**
558
824
  * Represents the rectangle location of each document field
559
825
  *
560
826
  */
561
- export class Rectangle {
827
+ export type Rectangle = {
562
828
  /**
563
829
  * X location
564
830
  *
@@ -582,25 +848,13 @@ export class Rectangle {
582
848
  *
583
849
  */
584
850
  height?: number;
585
-
586
- /**
587
- *
588
- * @param nativeRectangle
589
- *
590
- */
591
- constructor(nativeRectangle: any) {
592
- this.x = nativeRectangle.x;
593
- this.y = nativeRectangle.y;
594
- this.width = nativeRectangle.width;
595
- this.height = nativeRectangle.height;
596
- }
597
- }
851
+ };
598
852
 
599
853
  /**
600
854
  * Represents the information about the location of an element within a document or image.
601
855
  *
602
856
  */
603
- export class Location {
857
+ export type Location = {
604
858
  /**
605
859
  * Rectangle location of the result extracted from the OCR in the latin alphabet.
606
860
  *
@@ -624,80 +878,44 @@ export class Location {
624
878
  *
625
879
  */
626
880
  greek?: Rectangle;
627
-
628
- /**
629
- *
630
- * @param nativeLocation
631
- *
632
- */
633
- constructor(nativeLocation: any) {
634
- this.latin =
635
- nativeLocation.latin != undefined
636
- ? new Rectangle(nativeLocation.latin)
637
- : undefined;
638
- this.arabic =
639
- nativeLocation.arabic != undefined
640
- ? new Rectangle(nativeLocation.arabic)
641
- : undefined;
642
- this.cyrillic =
643
- nativeLocation.cyrillic != undefined
644
- ? new Rectangle(nativeLocation.cyrillic)
645
- : undefined;
646
- this.greek =
647
- nativeLocation.greek != undefined
648
- ? new Rectangle(nativeLocation.greek)
649
- : undefined;
650
- }
651
- }
881
+ };
652
882
 
653
883
  /**
654
- * Side of the document on which the specific result is located.
884
+ * Scanning side on which the specific result is located.
655
885
  *
656
886
  */
657
- export class Side {
887
+ export type Side = {
658
888
  /**
659
- * Document side of the result extracted from the OCR in the latin alphabet.
889
+ * Scanning side of the result extracted from the OCR in the latin alphabet.
660
890
  *
661
891
  */
662
- latin?: DocumentSide;
892
+ latin?: ScanningSide;
663
893
 
664
894
  /**
665
- * Document side of the result extracted from the OCR in the arabic alphabet.
895
+ * Scanning side of the result extracted from the OCR in the arabic alphabet.
666
896
  *
667
897
  */
668
- arabic?: DocumentSide;
898
+ arabic?: ScanningSide;
669
899
 
670
900
  /**
671
- * Document side of the result extracted from the OCR in the cyrillic alphabet.
901
+ * Scanning side of the result extracted from the OCR in the cyrillic alphabet.
672
902
  *
673
903
  */
674
- cyrillic?: DocumentSide;
904
+ cyrillic?: ScanningSide;
675
905
 
676
906
  /**
677
- * Document side of the result extracted from the OCR in the cyrillic alphabet.
907
+ * Scanning side of the result extracted from the OCR in the greek alphabet.
678
908
  *
679
909
  */
680
- greek?: DocumentSide;
681
-
682
- /**
683
- *
684
- * @param nativeSide
685
- *
686
- */
687
- constructor(nativeSide: any) {
688
- this.latin = nativeSide.latin;
689
- this.arabic = nativeSide.arabic;
690
- this.cyrillic = nativeSide.cyrillic;
691
- this.greek = nativeSide.greek;
692
- }
693
- }
910
+ greek?: ScanningSide;
911
+ };
694
912
 
695
913
  /**
696
914
  * Represents the result of the date extraction.
697
915
  *
698
916
  * Contains the extracted date, along with additional date information.
699
917
  */
700
- export class DateResult<T> {
918
+ export type DateResult<T> = {
701
919
  /**
702
920
  * The extracted date information.
703
921
  *
@@ -723,22 +941,13 @@ export class DateResult<T> {
723
941
  *
724
942
  */
725
943
  successfullyParsed?: boolean;
726
-
727
- constructor(nativeDateResult: any) {
728
- this.date = nativeDateResult.date;
729
- this.originalString = BlinkIdUtilities.handleStringType<T>(
730
- nativeDateResult.originalString,
731
- );
732
- this.isFilledByDomainKnowledge = nativeDateResult.isFilledByDomainKnowledge;
733
- this.successfullyParsed = nativeDateResult.successfullyParsed;
734
- }
735
- }
944
+ };
736
945
 
737
946
  /**
738
947
  * Represents the extracted date.
739
948
  *
740
949
  */
741
- export class Date {
950
+ export type Date = {
742
951
  /**
743
952
  * Day of the month.
744
953
  *
@@ -757,23 +966,13 @@ export class Date {
757
966
  *
758
967
  */
759
968
  year?: number;
760
-
761
- /**
762
- *
763
- * @param nativeDate
764
- */
765
- constructor(nativeDate: any) {
766
- this.day = nativeDate.day;
767
- this.month = nativeDate.month;
768
- this.year = nativeDate.year;
769
- }
770
- }
969
+ };
771
970
 
772
971
  /**
773
972
  * Represents detailed extracted information about the driver license.
774
973
  *
775
974
  */
776
- export class DriverLicenseDetailedInfo<T> {
975
+ export type DriverLicenseDetailedInfo<T> = {
777
976
  /**
778
977
  * The restrictions to driving privileges for the United States driver license owner.
779
978
  *
@@ -806,27 +1005,13 @@ export class DriverLicenseDetailedInfo<T> {
806
1005
  * See {@link VehicleClassInfo} for more information.
807
1006
  */
808
1007
  vehicleClassesInfo?: VehicleClassInfo<T>[];
809
-
810
- constructor(nativeDriverLicenseDetailedInfo: any) {
811
- this.restrictions = BlinkIdUtilities.handleStringType(
812
- nativeDriverLicenseDetailedInfo.restrictions,
813
- );
814
- this.endorsements = BlinkIdUtilities.handleStringType(
815
- nativeDriverLicenseDetailedInfo.endorsements,
816
- );
817
- this.vehicleClass = BlinkIdUtilities.handleStringType(
818
- nativeDriverLicenseDetailedInfo.vehicleClass,
819
- );
820
- this.vehicleClassesInfo =
821
- nativeDriverLicenseDetailedInfo.vehicleClassesInfo;
822
- }
823
- }
1008
+ };
824
1009
 
825
1010
  /**
826
1011
  * Represents the information about the vehicle class extraction.
827
1012
  *
828
1013
  */
829
- export class VehicleClassInfo<T> {
1014
+ export type VehicleClassInfo<T> = {
830
1015
  /**
831
1016
  * The type of driver licence.
832
1017
  *
@@ -852,24 +1037,13 @@ export class VehicleClassInfo<T> {
852
1037
  * See {@link DateResult} for more information.
853
1038
  */
854
1039
  expiryDate?: DateResult<T>;
855
-
856
- constructor(nativeVehicleClassInfo: any) {
857
- this.licenceType = BlinkIdUtilities.handleStringType<T>(
858
- nativeVehicleClassInfo.licenceType,
859
- );
860
- this.vehicleClass = BlinkIdUtilities.handleStringType<T>(
861
- nativeVehicleClassInfo.vehicleClass,
862
- );
863
- this.effectiveDate = nativeVehicleClassInfo.effectiveDate;
864
- this.expiryDate = nativeVehicleClassInfo.expiryDate;
865
- }
866
- }
1040
+ };
867
1041
 
868
1042
  /**
869
1043
  * Information about the dependent.
870
1044
  *
871
1045
  */
872
- export class DependentInfo {
1046
+ export type DependentInfo = {
873
1047
  /**
874
1048
  * The date of birth of the dependent.
875
1049
  *
@@ -899,21 +1073,13 @@ export class DependentInfo {
899
1073
  *
900
1074
  */
901
1075
  empty?: boolean;
902
-
903
- constructor(nativeDependentInfo: any) {
904
- this.dateOfBirth = nativeDependentInfo.dateOfBirth;
905
- this.sex = nativeDependentInfo.sex;
906
- this.documentNumber = nativeDependentInfo.documentNumber;
907
- this.fullName = nativeDependentInfo.fullName;
908
- this.empty = nativeDependentInfo.empty;
909
- }
910
- }
1076
+ };
911
1077
 
912
1078
  /**
913
1079
  * Represents the result of the image crop transformation with additional details.
914
1080
  *
915
1081
  */
916
- export class DetailedCroppedImageResult {
1082
+ export type DetailedCroppedImageResult = {
917
1083
  /**
918
1084
  * The cropped image in the Base64 format
919
1085
  *
@@ -931,24 +1097,7 @@ export class DetailedCroppedImageResult {
931
1097
  *
932
1098
  */
933
1099
  location?: Rectangle;
934
-
935
- /**
936
- *
937
- * @param nativeDetailedCroppedImageResult
938
- *
939
- */
940
- constructor(nativeDetailedCroppedImageResult: any) {
941
- this.image = nativeDetailedCroppedImageResult.image;
942
- this.side =
943
- nativeDetailedCroppedImageResult.side != undefined
944
- ? (nativeDetailedCroppedImageResult.side as ScanningSide)
945
- : undefined;
946
- this.location =
947
- nativeDetailedCroppedImageResult.location != undefined
948
- ? new Rectangle(nativeDetailedCroppedImageResult.location)
949
- : undefined;
950
- }
951
- }
1100
+ };
952
1101
 
953
1102
  /**
954
1103
  * Represents the result of scanning a single side of the document.
@@ -956,7 +1105,7 @@ export class DetailedCroppedImageResult {
956
1105
  * Contains the data extracted from the Visual Inspection Zone, Machine Readable Zone,
957
1106
  * barcode, the input image, and the cropped document, face, and signature images.
958
1107
  */
959
- export class SingleSideScanningResult {
1108
+ export type SingleSideScanningResult = {
960
1109
  /**
961
1110
  * The data extracted from the Visual Inspection Zone.
962
1111
  *
@@ -982,10 +1131,11 @@ export class SingleSideScanningResult {
982
1131
  inputImage?: string;
983
1132
 
984
1133
  /**
985
- * The input image containing parsable barcode in the Base64 format.
1134
+ * The cropped barcode image in the Base64 format when
1135
+ * {@link BarcodeModuleSettings.barcodeImageReturnEnabled} is enabled.
986
1136
  *
987
1137
  */
988
- barcodeInputImage?: string;
1138
+ barcodeImage?: string;
989
1139
 
990
1140
  /**
991
1141
  * The cropped document image in the Base64 format.
@@ -1004,29 +1154,13 @@ export class SingleSideScanningResult {
1004
1154
  *
1005
1155
  */
1006
1156
  signatureImage?: DetailedCroppedImageResult;
1007
-
1008
- /**
1009
- *
1010
- * @param nativeSingleSideScanningResult - specifies the single side scanning result obtained from the native SDK.
1011
- *
1012
- */
1013
- constructor(nativeSingleSideScanningResult: any) {
1014
- this.viz = nativeSingleSideScanningResult.viz;
1015
- this.mrz = nativeSingleSideScanningResult.mrz;
1016
- this.barcode = nativeSingleSideScanningResult.barcode;
1017
- this.inputImage = nativeSingleSideScanningResult.inputImage;
1018
- this.barcodeInputImage = nativeSingleSideScanningResult.barcodeInputImage;
1019
- this.documentImage = nativeSingleSideScanningResult.documentImage;
1020
- this.faceImage = nativeSingleSideScanningResult.faceImage;
1021
- this.signatureImage = nativeSingleSideScanningResult.signatureImage;
1022
- }
1023
- }
1157
+ };
1024
1158
 
1025
1159
  /**
1026
1160
  * Represents the result of the Visual Inspection Zone of a document.
1027
1161
  *
1028
1162
  */
1029
- export class VizResult {
1163
+ export type VizResult = {
1030
1164
  /**
1031
1165
  * The first name of the document owner.
1032
1166
  *
@@ -1105,6 +1239,12 @@ export class VizResult {
1105
1239
  */
1106
1240
  race?: StringResult;
1107
1241
 
1242
+ /**
1243
+ * The ethnicity of the document owner.
1244
+ *
1245
+ */
1246
+ ethnicity?: StringResult;
1247
+
1108
1248
  /**
1109
1249
  * The religion of the document owner.
1110
1250
  *
@@ -1243,6 +1383,11 @@ export class VizResult {
1243
1383
  */
1244
1384
  documentNumber?: StringResult;
1245
1385
 
1386
+ /**
1387
+ * The card access number
1388
+ */
1389
+ cardAccessNumber?: StringResult;
1390
+
1246
1391
  /**
1247
1392
  * The personal identification number.
1248
1393
  *
@@ -1387,87 +1532,13 @@ export class VizResult {
1387
1532
  * The work restriction of the document owner.
1388
1533
  */
1389
1534
  workRestriction?: StringResult;
1390
-
1391
- /**
1392
- *
1393
- * @param nativeVizResult
1394
- *
1395
- */
1396
- constructor(nativeVizResult: any) {
1397
- this.firstName = nativeVizResult.firstName;
1398
- this.lastName = nativeVizResult.lastName;
1399
- this.fullName = nativeVizResult.fullName;
1400
- this.additionalNameInformation = nativeVizResult.additionalNameInformation;
1401
- this.localizedName = nativeVizResult.localizedName;
1402
- this.fathersName = nativeVizResult.fathersName;
1403
- this.mothersName = nativeVizResult.mothersName;
1404
- this.address = nativeVizResult.address;
1405
- this.additionalAddressInformation =
1406
- nativeVizResult.additionalAddressInformation;
1407
- this.additionalOptionalAddressInformation =
1408
- nativeVizResult.additionalOptionalAddressInformation;
1409
- this.placeOfBirth = nativeVizResult.placeOfBirth;
1410
- this.nationality = nativeVizResult.nationality;
1411
- this.race = nativeVizResult.race;
1412
- this.religion = nativeVizResult.religion;
1413
- this.profession = nativeVizResult.profession;
1414
- this.maritalStatus = nativeVizResult.maritalStatus;
1415
- this.residentialStatus = nativeVizResult.residentialStatus;
1416
- this.employer = nativeVizResult.employer;
1417
- this.sex = nativeVizResult.sex;
1418
- this.sponsor = nativeVizResult.sponsor;
1419
- this.bloodType = nativeVizResult.bloodType;
1420
- this.dateOfBirth = nativeVizResult.dateOfBirth;
1421
- this.dateOfIssue = nativeVizResult.dateOfIssue;
1422
- this.dateOfExpiry = nativeVizResult.dateOfExpiry;
1423
- this.dateOfEntry = nativeVizResult.dateOfEntry;
1424
- this.localityCode = nativeVizResult.localityCode;
1425
- this.maidenName = nativeVizResult.maidenName;
1426
- this.municipalityCode = nativeVizResult.municipalityCode;
1427
- this.municipalityOfRegistration =
1428
- nativeVizResult.municipalityOfRegistration;
1429
- this.pollingStationCode = nativeVizResult.pollingStationCode;
1430
- this.registrationCenterCode = nativeVizResult.registrationCenterCode;
1431
- this.sectionCode = nativeVizResult.sectionCode;
1432
- this.stateCode = nativeVizResult.stateCode;
1433
- this.stateName = nativeVizResult.stateName;
1434
- this.dateOfExpiryPermanent = nativeVizResult.dateOfExpiryPermanent;
1435
- this.documentNumber = nativeVizResult.documentNumber;
1436
- this.personalIdNumber = nativeVizResult.personalIdNumber;
1437
- this.documentAdditionalNumber = nativeVizResult.documentAdditionalNumber;
1438
- this.documentOptionalAdditionalNumber =
1439
- nativeVizResult.documentOptionalAdditionalNumber;
1440
- this.additionalPersonalIdNumber =
1441
- nativeVizResult.additionalPersonalIdNumber;
1442
- this.issuingAuthority = nativeVizResult.issuingAuthority;
1443
- this.visaType = nativeVizResult.visaType;
1444
- this.driverLicenseDetailedInfo = nativeVizResult.driverLicenseDetailedInfo;
1445
- this.documentSubtype = nativeVizResult.documentSubtype;
1446
- this.remarks = nativeVizResult.remarks;
1447
- this.residencePermitType = nativeVizResult.residencePermitType;
1448
- this.manufacturingYear = nativeVizResult.manufacturingYear;
1449
- this.vehicleType = nativeVizResult.vehicleType;
1450
- this.eligibilityCategory = nativeVizResult.eligibilityCategory;
1451
- this.specificDocumentValidity = nativeVizResult.specificDocumentValidity;
1452
- this.dependentsInfo = nativeVizResult.dependentsInfo;
1453
- this.vehicleOwner = nativeVizResult.vehicleOwner;
1454
- this.countryCode = nativeVizResult.countryCode;
1455
- this.certificateNumber = nativeVizResult.certificateNumber;
1456
- this.nationalInsuranceNumber = nativeVizResult.nationalInsuranceNumber;
1457
- this.effectiveDate = nativeVizResult.effectiveDate;
1458
- this.parentsInfo = nativeVizResult.parentsInfo;
1459
- this.husbandName = nativeVizResult.husbandName;
1460
- this.legalStatus = nativeVizResult.legalStatus;
1461
- this.socialSecurityStatus = nativeVizResult.socialSecurityStatus;
1462
- this.workRestriction = nativeVizResult.workRestriction;
1463
- }
1464
- }
1535
+ };
1465
1536
 
1466
1537
  /**
1467
1538
  * Represents the result of the MRZ recognition.
1468
1539
  *
1469
1540
  */
1470
- export class MrzResult {
1541
+ export type MrzResult = {
1471
1542
  /**
1472
1543
  * The entire Machine Readable Zone text from ID.
1473
1544
  *
@@ -1620,43 +1691,13 @@ export class MrzResult {
1620
1691
  * Result without additional '<' characters if they exist.
1621
1692
  */
1622
1693
  sanitizedDocumentNumber?: string;
1623
-
1624
- /**
1625
- *
1626
- * @param nativeMrzResult
1627
- *
1628
- */
1629
- constructor(nativeMrzResult: any) {
1630
- this.rawMRZString = nativeMrzResult.rawMRZString;
1631
- this.documentCode = nativeMrzResult.documentCode;
1632
- this.issuer = nativeMrzResult.issuer;
1633
- this.documentNumber = nativeMrzResult.documentNumber;
1634
- this.opt1 = nativeMrzResult.opt1;
1635
- this.opt2 = nativeMrzResult.opt2;
1636
- this.gender = nativeMrzResult.gender;
1637
- this.nationality = nativeMrzResult.nationality;
1638
- this.primaryID = nativeMrzResult.primaryID;
1639
- this.secondaryID = nativeMrzResult.secondaryID;
1640
- this.issuerName = nativeMrzResult.issuerName;
1641
- this.nationalityName = nativeMrzResult.nationalityName;
1642
- this.verified = nativeMrzResult.verified;
1643
- this.dateOfBirth = nativeMrzResult.dateOfBirth;
1644
- this.dateOfExpiry = nativeMrzResult.dateOfExpiry;
1645
- this.documentType = nativeMrzResult.documentType;
1646
- this.sanitizedOpt1 = nativeMrzResult.sanitizedOpt1;
1647
- this.sanitizedOpt2 = nativeMrzResult.sanitizedOpt2;
1648
- this.sanitizedNationality = nativeMrzResult.sanitizedNationality;
1649
- this.sanitizedIssuer = nativeMrzResult.sanitizedIssuer;
1650
- this.sanitizedDocumentCode = nativeMrzResult.sanitizedDocumentCode;
1651
- this.sanitizedDocumentNumber = nativeMrzResult.sanitizedDocumentNumber;
1652
- }
1653
- }
1694
+ };
1654
1695
 
1655
1696
  /**
1656
1697
  * Represents the data extracted from the barcode.
1657
1698
  *
1658
1699
  */
1659
- export class BarcodeResult {
1700
+ export type BarcodeResult = {
1660
1701
  /**
1661
1702
  * The raw, unparsed barcode data.
1662
1703
  *
@@ -1817,50 +1858,13 @@ export class BarcodeResult {
1817
1858
  * Indicates whether the barcode was successfully parsed.
1818
1859
  */
1819
1860
  parsed?: boolean;
1820
-
1821
- /**
1822
- *
1823
- * @param nativeBarcodeResult
1824
- */
1825
- constructor(nativeBarcodeResult: any) {
1826
- this.barcodeData = nativeBarcodeResult.barcodeData;
1827
- this.firstName = nativeBarcodeResult.firstName;
1828
- this.middleName = nativeBarcodeResult.middleName;
1829
- this.lastName = nativeBarcodeResult.lastName;
1830
- this.fullName = nativeBarcodeResult.fullName;
1831
- this.additionalNameInformation =
1832
- nativeBarcodeResult.additionalNameInformation;
1833
- this.address = nativeBarcodeResult.address;
1834
- this.placeOfBirth = nativeBarcodeResult.placeOfBirth;
1835
- this.nationality = nativeBarcodeResult.nationality;
1836
- this.race = nativeBarcodeResult.race;
1837
- this.religion = nativeBarcodeResult.religion;
1838
- this.profession = nativeBarcodeResult.profession;
1839
- this.maritalStatus = nativeBarcodeResult.maritalStatus;
1840
- this.residentialStatus = nativeBarcodeResult.residentialStatus;
1841
- this.employer = nativeBarcodeResult.employer;
1842
- this.sex = nativeBarcodeResult.sex;
1843
- this.dateOfBirth = nativeBarcodeResult.dateOfBirth;
1844
- this.dateOfIssue = nativeBarcodeResult.dateOfIssue;
1845
- this.dateOfExpiry = nativeBarcodeResult.dateOfExpiry;
1846
- this.documentNumber = nativeBarcodeResult.documentNumber;
1847
- this.personalIdNumber = nativeBarcodeResult.personalIdNumber;
1848
- this.documentAdditionalNumber =
1849
- nativeBarcodeResult.documentAdditionalNumber;
1850
- this.issuingAuthority = nativeBarcodeResult.issuingAuthority;
1851
- this.addressDetailedInfo = nativeBarcodeResult.addressDetailedInfo;
1852
- this.driverLicenseDetailedInfo =
1853
- nativeBarcodeResult.driverLicenseDetailedInfo;
1854
- this.extendedElements = nativeBarcodeResult.extendedElements;
1855
- this.parsed = nativeBarcodeResult.parsed;
1856
- }
1857
- }
1861
+ };
1858
1862
 
1859
1863
  /**
1860
1864
  * Represents the raw, unparsed data extracted from a scanned barcode.
1861
1865
  *
1862
1866
  */
1863
- export class BarcodeData {
1867
+ export type BarcodeData = {
1864
1868
  /**
1865
1869
  * Type of the scanned barcode.
1866
1870
  *
@@ -1884,24 +1888,13 @@ export class BarcodeData {
1884
1888
  *
1885
1889
  */
1886
1890
  uncertain?: boolean;
1887
-
1888
- /**
1889
- *
1890
- * @param nativeBarcodeData - specifies the barcode data obtained from the native SDK.
1891
- */
1892
- constructor(nativeBarcodeData: any) {
1893
- this.barcodeType = nativeBarcodeData.barcodeType;
1894
- this.rawData = nativeBarcodeData.rawData;
1895
- this.stringData = nativeBarcodeData.stringData;
1896
- this.uncertain = nativeBarcodeData.uncertain;
1897
- }
1898
- }
1891
+ };
1899
1892
 
1900
1893
  /**
1901
1894
  * Detailed information about the address.
1902
1895
  *
1903
1896
  */
1904
- export class AddressDetailedInfo {
1897
+ export type AddressDetailedInfo = {
1905
1898
  /**
1906
1899
  * he address street portion of the document owner.
1907
1900
  *
@@ -1925,24 +1918,12 @@ export class AddressDetailedInfo {
1925
1918
  *
1926
1919
  */
1927
1920
  jurisdiction?: string;
1928
-
1929
- /**
1930
- *
1931
- * @param nativeAddressDetailedInfo - specificies the address detailed info obtained from the native SDK.
1932
- *
1933
- */
1934
- constructor(nativeAddressDetailedInfo: any) {
1935
- this.street = nativeAddressDetailedInfo.street;
1936
- this.postalCode = nativeAddressDetailedInfo.postalCode;
1937
- this.city = nativeAddressDetailedInfo.city;
1938
- this.jurisdiction = nativeAddressDetailedInfo.jurisdiction;
1939
- }
1940
- }
1921
+ };
1941
1922
  /**
1942
1923
  * Represents the fields present in the barcode.
1943
1924
  * Currently this is only used for AAMVACompliant documents.
1944
1925
  */
1945
- export class BarcodeExtendedElements {
1926
+ export type BarcodeExtendedElements = {
1946
1927
  /**
1947
1928
  * Mandatory on all AAMVA and Magnetic barcodes.
1948
1929
  * On compact barcodes, use kFullAddress.
@@ -2806,136 +2787,12 @@ export class BarcodeExtendedElements {
2806
2787
  * For example: ANSI 636010090002DL00410267ZF03080067DLDAQS1234567812300000000000000 ^^ | | | +-- SubField Designator (DL, ID, EN, etc.) +----- IIN (636010)
2807
2788
  */
2808
2789
  subFieldDesignator?: string;
2809
-
2810
- /**
2811
- *
2812
- * @param nativeBarcodeExtendedElements - specifies the extended barcode elements obtained from the native SDK.
2813
- */
2814
- constructor(nativeBarcodeExtendedElements: any) {
2815
- this.addressCity = nativeBarcodeExtendedElements.addressCity;
2816
- this.addressJurisdictionCode =
2817
- nativeBarcodeExtendedElements.addressJurisdictionCode;
2818
- this.addressPostalCode = nativeBarcodeExtendedElements.addressPostalCode;
2819
- this.addressStreet = nativeBarcodeExtendedElements.addressStreet;
2820
- this.addressStreet2 = nativeBarcodeExtendedElements.addressStreet2;
2821
- this.akaDateOfBirth = nativeBarcodeExtendedElements.akaDateOfBirth;
2822
- this.akaFamilyName = nativeBarcodeExtendedElements.akaFamilyName;
2823
- this.akaFullName = nativeBarcodeExtendedElements.akaFullName;
2824
- this.akaGivenName = nativeBarcodeExtendedElements.akaGivenName;
2825
- this.akaMiddleName = nativeBarcodeExtendedElements.akaMiddleName;
2826
- this.akaPrefixName = nativeBarcodeExtendedElements.akaPrefixName;
2827
- this.akaSocialSecurityNumber =
2828
- nativeBarcodeExtendedElements.akaSocialSecurityNumber;
2829
- this.akaSuffixName = nativeBarcodeExtendedElements.akaSuffixName;
2830
- this.auditInformation = nativeBarcodeExtendedElements.auditInformation;
2831
- this.cardRevisionDate = nativeBarcodeExtendedElements.cardRevisionDate;
2832
- this.complianceType = nativeBarcodeExtendedElements.complianceType;
2833
- this.countryIdentification =
2834
- nativeBarcodeExtendedElements.countryIdentification;
2835
- this.customerFamilyName = nativeBarcodeExtendedElements.customerFamilyName;
2836
- this.customerIdNumber = nativeBarcodeExtendedElements.customerIdNumber;
2837
- this.customerFirstName = nativeBarcodeExtendedElements.customerFirstName;
2838
- this.customerFullName = nativeBarcodeExtendedElements.customerFullName;
2839
- this.customerMiddleName = nativeBarcodeExtendedElements.customerMiddleName;
2840
- this.dataDiscriminator = nativeBarcodeExtendedElements.dataDiscriminator;
2841
- this.dateOfBirth = nativeBarcodeExtendedElements.dateOfBirth;
2842
- this.documentDiscriminator =
2843
- nativeBarcodeExtendedElements.documentDiscriminator;
2844
- this.documentExpirationDate =
2845
- nativeBarcodeExtendedElements.documentExpirationDate;
2846
- this.documentExpirationMonth =
2847
- nativeBarcodeExtendedElements.documentExpirationMonth;
2848
- this.documentIssueDate = nativeBarcodeExtendedElements.documentIssueDate;
2849
- this.documentNonexpiring =
2850
- nativeBarcodeExtendedElements.documentNonexpiring;
2851
- this.documentType = nativeBarcodeExtendedElements.documentType;
2852
- this.eyeColor = nativeBarcodeExtendedElements.eyeColor;
2853
- this.familyNameTruncation =
2854
- nativeBarcodeExtendedElements.familyNameTruncation;
2855
- this.federalCommercialVehicleCodes =
2856
- nativeBarcodeExtendedElements.federalCommercialVehicleCodes;
2857
- this.firstNameTruncation =
2858
- nativeBarcodeExtendedElements.firstNameTruncation;
2859
- this.fullAddress = nativeBarcodeExtendedElements.fullAddress;
2860
- this.hairColor = nativeBarcodeExtendedElements.hairColor;
2861
- this.height = nativeBarcodeExtendedElements.height;
2862
- this.heightIn = nativeBarcodeExtendedElements.heightIn;
2863
- this.heightCm = nativeBarcodeExtendedElements.heightCm;
2864
- this.issuerIdentificationNumber =
2865
- nativeBarcodeExtendedElements.issuerIdentificationNumber;
2866
- this.issuingJurisdiction =
2867
- nativeBarcodeExtendedElements.issuingJurisdiction;
2868
- this.issuingJurisdictionName =
2869
- nativeBarcodeExtendedElements.issuingJurisdictionName;
2870
- this.jurisdictionEndorsementCodes =
2871
- nativeBarcodeExtendedElements.jurisdictionEndorsementCodes;
2872
- this.jurisdictionEndorsmentCodeDescription =
2873
- nativeBarcodeExtendedElements.jurisdictionEndorsmentCodeDescription;
2874
- this.jurisdictionRestrictionCodeDescription =
2875
- nativeBarcodeExtendedElements.jurisdictionRestrictionCodeDescription;
2876
- this.jurisdictionRestrictionCodes =
2877
- nativeBarcodeExtendedElements.jurisdictionRestrictionCodes;
2878
- this.jurisdictionVehicleClass =
2879
- nativeBarcodeExtendedElements.jurisdictionVehicleClass;
2880
- this.jurisdictionVehicleClassificationDescription =
2881
- nativeBarcodeExtendedElements.jurisdictionVehicleClassificationDescription;
2882
- this.jurisdictionVersionNumber =
2883
- nativeBarcodeExtendedElements.jurisdictionVersionNumber;
2884
- this.limitedDurationDocument =
2885
- nativeBarcodeExtendedElements.limitedDurationDocument;
2886
- this.medicalIndicator = nativeBarcodeExtendedElements.medicalIndicator;
2887
- this.middleNameTruncation =
2888
- nativeBarcodeExtendedElements.middleNameTruncation;
2889
- this.namePrefix = nativeBarcodeExtendedElements.namePrefix;
2890
- this.nameSuffix = nativeBarcodeExtendedElements.nameSuffix;
2891
- this.nonResident = nativeBarcodeExtendedElements.nonResident;
2892
- this.numberOfDuplicates = nativeBarcodeExtendedElements.numberOfDuplicates;
2893
- this.organDonor = nativeBarcodeExtendedElements.organDonor;
2894
- this.permitExpirationDate =
2895
- nativeBarcodeExtendedElements.permitExpirationDate;
2896
- this.permitIdentifier = nativeBarcodeExtendedElements.permitIdentifier;
2897
- this.permitIssueDate = nativeBarcodeExtendedElements.permitIssueDate;
2898
- this.placeOfBirth = nativeBarcodeExtendedElements.placeOfBirth;
2899
- this.raceEthnicity = nativeBarcodeExtendedElements.raceEthnicity;
2900
- this.residenceCity = nativeBarcodeExtendedElements.residenceCity;
2901
- this.residenceFullAddress =
2902
- nativeBarcodeExtendedElements.residenceFullAddress;
2903
- this.residenceJurisdictionCode =
2904
- nativeBarcodeExtendedElements.residenceJurisdictionCode;
2905
- this.residencePostalCode =
2906
- nativeBarcodeExtendedElements.residencePostalCode;
2907
- this.residenceStreetAddress =
2908
- nativeBarcodeExtendedElements.residenceStreetAddress;
2909
- this.residenceStreetAddress2 =
2910
- nativeBarcodeExtendedElements.residenceStreetAddress2;
2911
- this.securityVersion = nativeBarcodeExtendedElements.securityVersion;
2912
- this.sex = nativeBarcodeExtendedElements.sex;
2913
- this.socialSecurityNumber =
2914
- nativeBarcodeExtendedElements.socialSecurityNumber;
2915
- this.standardEndorsementCode =
2916
- nativeBarcodeExtendedElements.standardEndorsementCode;
2917
- this.standardRestrictionCode =
2918
- nativeBarcodeExtendedElements.standardRestrictionCode;
2919
- this.standardVehicleClassification =
2920
- nativeBarcodeExtendedElements.standardVehicleClassification;
2921
- this.standardVersionNumber =
2922
- nativeBarcodeExtendedElements.standardVersionNumber;
2923
- this.under18 = nativeBarcodeExtendedElements.under18;
2924
- this.under19 = nativeBarcodeExtendedElements.under19;
2925
- this.under21 = nativeBarcodeExtendedElements.under21;
2926
- this.uniqueCustomerId = nativeBarcodeExtendedElements.uniqueCustomerId;
2927
- this.veteran = nativeBarcodeExtendedElements.veteran;
2928
- this.weightKilograms = nativeBarcodeExtendedElements.weightKilograms;
2929
- this.weightPounds = nativeBarcodeExtendedElements.weightPounds;
2930
- this.weightRange = nativeBarcodeExtendedElements.weightRange;
2931
- this.subFieldDesignator = nativeBarcodeExtendedElements.subFieldDesignator;
2932
- }
2933
- }
2790
+ };
2934
2791
 
2935
2792
  /**
2936
2793
  * The results of parents info.
2937
2794
  */
2938
- export class ParentInfo {
2795
+ export type ParentInfo = {
2939
2796
  /**
2940
2797
  * The first name of one of the document owner's parents.
2941
2798
  */
@@ -2946,11 +2803,11 @@ export class ParentInfo {
2946
2803
  */
2947
2804
  lastName?: StringResult;
2948
2805
 
2949
- constructor(nativeParentInfo: any) {
2950
- this.firstName = nativeParentInfo.firstName;
2951
- this.lastName = nativeParentInfo.lastName;
2952
- }
2953
- }
2806
+ /**
2807
+ * The full name of one of the document owner's parents.
2808
+ */
2809
+ fullName?: StringResult;
2810
+ };
2954
2811
 
2955
2812
  /**
2956
2813
  * Represents the mode of document scanning.
@@ -2958,50 +2815,48 @@ export class ParentInfo {
2958
2815
  * This enum class defines whether the scanning process is limited to a single
2959
2816
  * side of the document or includes multiple sides, automatically identifying how many sides need to be scanned.
2960
2817
  */
2961
- export enum ScanningMode {
2818
+ export type ScanningMode =
2962
2819
  /**
2963
2820
  * Specifies the scanning process to be for single side only.
2964
2821
  *
2965
2822
  */
2966
- Single = 0,
2823
+ | "single"
2967
2824
 
2968
2825
  /**
2969
2826
  * The default `ScanningMode`.
2970
2827
  *
2971
2828
  * Automatically determines the number of sides to scan.
2972
2829
  */
2973
- Automatic = 1,
2974
- }
2830
+ | "automatic";
2975
2831
 
2976
2832
  /**
2977
2833
  * Represents the type of the alphabet used in the document.
2978
2834
  *
2979
2835
  */
2980
- export enum AlphabetType {
2836
+ export type AlphabetType =
2981
2837
  /**
2982
2838
  * The Latin alphabet type
2983
2839
  *
2984
2840
  */
2985
- Latin = "latin",
2841
+ | "latin"
2986
2842
 
2987
2843
  /**
2988
2844
  * The Arabic alphabet type
2989
2845
  *
2990
2846
  */
2991
- Arabic = "arabic",
2847
+ | "arabic"
2992
2848
 
2993
2849
  /**
2994
2850
  * The Cyrillic alphabet type
2995
2851
  *
2996
2852
  */
2997
- Cyrillic = "cyrillic",
2853
+ | "cyrillic"
2998
2854
 
2999
2855
  /**
3000
2856
  * The Greek alphabet type
3001
2857
  *
3002
2858
  */
3003
- Greek = "greek",
3004
- }
2859
+ | "greek";
3005
2860
 
3006
2861
  /**
3007
2862
  * Represents the different levels of detection sensitivity.
@@ -3012,1530 +2867,1465 @@ export enum AlphabetType {
3012
2867
  * The levels range from turning detection
3013
2868
  * off completely to setting various levels of sensitivity (`Low`, `Mid`, `High`).
3014
2869
  */
3015
- export enum DetectionLevel {
2870
+ export type SensitivityLevel =
3016
2871
  /**
3017
2872
  * Disables the `DetectionLevel`
3018
2873
  *
3019
2874
  */
3020
- Off = 0,
2875
+ | "off"
3021
2876
 
3022
2877
  /**
3023
2878
  * Sets the `DetectionLevel` to be less sensitive.
3024
2879
  *
3025
2880
  */
3026
- Low = 1,
2881
+ | "low"
3027
2882
 
3028
2883
  /**
3029
2884
  * The default `DetectionLevel` sensitivity.
3030
2885
  *
3031
2886
  */
3032
- Mid = 2,
2887
+ | "mid"
3033
2888
 
3034
2889
  /**
3035
2890
  * Sets the `DetectionLevel` to be highly sensitive.
3036
2891
  *
3037
2892
  */
3038
- High = 3,
3039
- }
2893
+ | "high";
3040
2894
 
3041
2895
  /**
3042
2896
  * Represents level of anonymization performed on the scanning result.
3043
2897
  *
3044
2898
  */
3045
- export enum AnonymizationMode {
2899
+ export type RedactionMode =
3046
2900
  /**
3047
2901
  * Anonymization will not be performed.
3048
2902
  *
3049
2903
  */
3050
- None = "none",
2904
+ | "none"
3051
2905
 
3052
2906
  /**
3053
2907
  * Full document image is anonymized with black boxes covering sensitive data.
3054
2908
  *
3055
2909
  */
3056
- ImageOnly = "imageOnly",
2910
+ | "imageOnly"
3057
2911
 
3058
2912
  /**
3059
2913
  * Result fields containing sensitive data are removed from result.
3060
2914
  *
3061
2915
  */
3062
- ResultFieldsOnly = "resultFieldsOnly",
2916
+ | "resultFieldsOnly"
3063
2917
 
3064
2918
  /**
3065
2919
  * This mode is combination of `imageOnly` and `resultFieldsOnly` modes.
3066
2920
  *
3067
2921
  */
3068
- FullResult = "fullResult",
3069
- }
3070
-
3071
- /**
3072
- * Represents possible recognition modes.
3073
- *
3074
- */
3075
- export const enum RecognitionMode {
3076
- /**
3077
- * No recognition performed.
3078
- *
3079
- */
3080
- None = "none",
3081
-
3082
- /**
3083
- * Recognition of mrz document (does not include visa and passport).
3084
- *
3085
- */
3086
- MrzId = "mrzId",
3087
-
3088
- /**
3089
- * Recognition of visa mrz.
3090
- *
3091
- */
3092
- MrzVisa = "mrzVisa",
3093
-
3094
- /**
3095
- * Recognition of passport mrz.
3096
- *
3097
- */
3098
-
3099
- MrzPassport = "mrzPassport",
3100
-
3101
- /*
3102
- * Recognition of documents that have face photo on the front.
3103
- *
3104
- */
3105
- PhotoId = "photoId",
3106
-
3107
- /**
3108
- * Detailed document recognition.
3109
- *
3110
- */
3111
- FullRecognition = "fullRecognition",
3112
-
3113
- /**
3114
- * Recognition of barcode document.
3115
- *
3116
- */
3117
- BarcodeId = "barcodeId",
3118
- }
3119
-
3120
- /**
3121
- * Define document side where the document field is located.
3122
- *
3123
- */
3124
- export enum DocumentSide {
3125
- /**
3126
- * The field is located on the front side of the document
3127
- *
3128
- */
3129
- Front = 0,
3130
-
3131
- /**
3132
- * The field is located on the back side of the document
3133
- *
3134
- */
3135
- Back = 1,
3136
- }
2922
+ | "fullResult";
3137
2923
 
3138
2924
  /**
3139
2925
  * Represents the type of scanned barcode
3140
2926
  *
3141
2927
  */
3142
- export enum BarcodeType {
2928
+ export type BarcodeType =
3143
2929
  /**
3144
2930
  * No barcode was scanned
3145
2931
  *
3146
2932
  */
3147
- None = 0,
2933
+ | "none"
3148
2934
 
3149
2935
  /**
3150
2936
  * QR code was scanned
3151
2937
  *
3152
2938
  */
3153
- QrCode = 1,
2939
+ | "qrCode"
3154
2940
 
3155
2941
  /**
3156
2942
  * Data Matrix 2D barcode was scanned
3157
2943
  *
3158
2944
  */
3159
- DataMatrix = 2,
2945
+ | "dataMatrix"
3160
2946
 
3161
2947
  /**
3162
2948
  * UPC E barcode was scanned
3163
2949
  *
3164
2950
  */
3165
- Upce = 3,
2951
+ | "upce"
3166
2952
 
3167
2953
  /**
3168
2954
  * UPC A barcode was scanned
3169
2955
  *
3170
2956
  */
3171
- Upca = 4,
2957
+ | "upca"
3172
2958
 
3173
2959
  /**
3174
2960
  * EAN 8 barcode was scanned
3175
2961
  *
3176
2962
  */
3177
- Ean8 = 5,
2963
+ | "ean8"
3178
2964
 
3179
2965
  /**
3180
2966
  * EAN 13 barcode was scanned
3181
2967
  *
3182
2968
  */
3183
- Ean13 = 6,
2969
+ | "ean13"
3184
2970
 
3185
2971
  /**
3186
2972
  * Code 128 barcode was scanned
3187
2973
  *
3188
2974
  */
3189
- Code128 = 7,
2975
+ | "code128"
3190
2976
 
3191
2977
  /**
3192
2978
  * Code 39 barcode was scanned
3193
2979
  *
3194
2980
  */
3195
- Code39 = 8,
2981
+ | "code39"
3196
2982
 
3197
2983
  /**
3198
2984
  * ITF barcode was scanned
3199
2985
  *
3200
2986
  */
3201
- Itf = 9,
2987
+ | "itf"
3202
2988
 
3203
2989
  /**
3204
2990
  * Aztec 2D barcode was scanned
3205
2991
  *
3206
2992
  */
3207
- Aztec = 10,
2993
+ | "aztec"
3208
2994
 
3209
2995
  /**
3210
2996
  * PDF417 2D barcode was scanned
3211
2997
  *
3212
2998
  */
3213
- Pdf417 = 11,
3214
- }
2999
+ | "pdf417";
3215
3000
 
3216
3001
  /**
3217
3002
  * Represents the document type found on the Machine Readable Zone
3218
3003
  *
3219
3004
  */
3220
- export enum MRZDocumentType {
3005
+ export type MRZDocumentType =
3221
3006
  /**
3222
3007
  * Document type was not identified.
3223
3008
  *
3224
3009
  */
3225
- Unknown = 0,
3010
+ | "unknown"
3226
3011
 
3227
3012
  /**
3228
3013
  * Identity card
3229
3014
  *
3230
3015
  */
3231
- IdentityCard = 1,
3016
+ | "identityCard"
3232
3017
 
3233
3018
  /**
3234
3019
  * Passport
3235
3020
  *
3236
3021
  */
3237
- Passport = 2,
3022
+ | "passport"
3238
3023
 
3239
3024
  /**
3240
3025
  * VISA
3241
3026
  *
3242
3027
  */
3243
- Visa = 3,
3028
+ | "visa"
3244
3029
 
3245
3030
  /**
3246
3031
  * Green card
3247
3032
  *
3248
3033
  */
3249
- GreenCard = 4,
3034
+ | "greenCard"
3250
3035
 
3251
3036
  /**
3252
3037
  * IIM13P Pass
3253
3038
  *
3254
3039
  */
3255
- MysPassIMM13P = 5,
3040
+ | "mysPassIMM13P"
3256
3041
 
3257
3042
  /**
3258
3043
  * Driver license
3259
3044
  *
3260
3045
  */
3261
- DriverLicense = 6,
3046
+ | "driverLicense"
3262
3047
 
3263
3048
  /**
3264
3049
  * Internal travel document
3265
3050
  *
3266
3051
  */
3267
- InternalTravelDocument = 7,
3052
+ | "internalTravelDocument"
3268
3053
 
3269
3054
  /**
3270
3055
  * Border crossing card
3271
3056
  *
3272
3057
  */
3273
- BorderCrossingCard = 8,
3274
- }
3058
+ | "borderCrossingCard";
3275
3059
 
3276
3060
  /**
3277
3061
  * Represents the side of the document being scanned.
3278
3062
  *
3279
3063
  */
3280
- enum ScanningSide {
3064
+ export type ScanningSide =
3281
3065
  /**
3282
3066
  * The first side of the scanned document
3283
3067
  *
3284
3068
  */
3285
- First = 0,
3069
+ | "first"
3286
3070
 
3287
3071
  /**
3288
3072
  * The second side of the scanned document
3289
3073
  *
3290
3074
  */
3291
- Second = 1,
3292
- }
3075
+ | "second";
3293
3076
 
3294
3077
  /**
3295
3078
  * Represents the type of the field used in data match.
3296
3079
  *
3297
3080
  */
3298
- export enum DataMatchField {
3081
+ export type DataMatchField =
3299
3082
  /**
3300
3083
  * The date of birth field.
3301
3084
  *
3302
3085
  */
3303
- DateOfBirth = 0,
3086
+ | "dateOfBirth"
3304
3087
 
3305
3088
  /**
3306
3089
  * The date of expiry field.
3307
3090
  *
3308
3091
  */
3309
- DateOfExpiry = 1,
3092
+ | "dateOfExpiry"
3310
3093
 
3311
3094
  /**
3312
3095
  * The document number field.
3313
3096
  *
3314
3097
  */
3315
- DocumentNumber = 2,
3098
+ | "documentNumber"
3316
3099
 
3317
3100
  /**
3318
3101
  * The document additional number field.
3319
3102
  *
3320
3103
  */
3321
- DocumentAdditionalNumber = 3,
3104
+ | "documentAdditionalNumber"
3322
3105
 
3323
3106
  /**
3324
3107
  * The document optional additional number field.
3325
3108
  *
3326
3109
  */
3327
- DocumentOptionalAdditionalNumber = 4,
3110
+ | "documentOptionalAdditionalNumber"
3328
3111
 
3329
3112
  /**
3330
3113
  * The personal ID number field.
3331
3114
  *
3332
3115
  */
3333
-
3334
- PersonalIdNumber = 5,
3335
- }
3116
+ | "personalIdNumber";
3336
3117
 
3337
3118
  /**
3338
3119
  * Represents the state of the data match.
3339
3120
  *
3340
3121
  */
3341
- export enum DataMatchState {
3122
+ export type DataMatchState =
3342
3123
  /**
3343
3124
  * Data matching has not been performed.
3344
3125
  *
3345
3126
  */
3346
- NotPerformed = 0,
3127
+ | "notPerformed"
3347
3128
 
3348
3129
  /**
3349
3130
  * Data does not match.
3350
3131
  *
3351
3132
  */
3352
- Failed = 1,
3133
+ | "failed"
3353
3134
 
3354
3135
  /**
3355
3136
  * Data does match.
3356
3137
  *
3357
3138
  */
3358
- Success = 2,
3359
- }
3139
+ | "success";
3360
3140
 
3361
3141
  /**
3362
3142
  * Document country.
3363
3143
  *
3364
3144
  */
3365
- export enum Country {
3366
- None = "none",
3145
+ export const CountryID = {
3146
+ None: "none",
3367
3147
 
3368
- Albania = "albania",
3148
+ Albania: "albania",
3369
3149
 
3370
- Algeria = "algeria",
3150
+ Algeria: "algeria",
3371
3151
 
3372
- Argentina = "argentina",
3152
+ Argentina: "argentina",
3373
3153
 
3374
- Australia = "australia",
3154
+ Australia: "australia",
3375
3155
 
3376
- Austria = "austria",
3156
+ Austria: "austria",
3377
3157
 
3378
- Azerbaijan = "azerbaijan",
3158
+ Azerbaijan: "azerbaijan",
3379
3159
 
3380
- Bahrain = "bahrain",
3160
+ Bahrain: "bahrain",
3381
3161
 
3382
- Bangladesh = "bangladesh",
3162
+ Bangladesh: "bangladesh",
3383
3163
 
3384
- Belgium = "belgium",
3164
+ Belgium: "belgium",
3385
3165
 
3386
- BosniaAndHerzegovina = "bosniaAndHerzegovina",
3166
+ BosniaAndHerzegovina: "bosniaAndHerzegovina",
3387
3167
 
3388
- Brunei = "brunei",
3168
+ Brunei: "brunei",
3389
3169
 
3390
- Bulgaria = "bulgaria",
3170
+ Bulgaria: "bulgaria",
3391
3171
 
3392
- Bambodia = "bambodia",
3172
+ Bambodia: "bambodia",
3393
3173
 
3394
- Canada = "canada",
3174
+ Canada: "canada",
3395
3175
 
3396
- Chile = "chile",
3176
+ Chile: "chile",
3397
3177
 
3398
- Colombia = "colombia",
3178
+ Colombia: "colombia",
3399
3179
 
3400
- CostaRica = "costaRica",
3180
+ CostaRica: "costaRica",
3401
3181
 
3402
- Croatia = "croatia",
3182
+ Croatia: "croatia",
3403
3183
 
3404
- Cyprus = "cyprus",
3184
+ Cyprus: "cyprus",
3405
3185
 
3406
- Czechia = "czechia",
3186
+ Czechia: "czechia",
3407
3187
 
3408
- Denmark = "denmark",
3188
+ Denmark: "denmark",
3409
3189
 
3410
- DominicanRepublic = "dominicanRepublic",
3190
+ DominicanRepublic: "dominicanRepublic",
3411
3191
 
3412
- Egypt = "egypt",
3192
+ Egypt: "egypt",
3413
3193
 
3414
- Estonia = "estonia",
3194
+ Estonia: "estonia",
3415
3195
 
3416
- Finland = "finland",
3196
+ Finland: "finland",
3417
3197
 
3418
- France = "france",
3198
+ France: "france",
3419
3199
 
3420
- Georgia = "georgia",
3200
+ Georgia: "georgia",
3421
3201
 
3422
- Germany = "germany",
3202
+ Germany: "germany",
3423
3203
 
3424
- Ghana = "ghana",
3204
+ Ghana: "ghana",
3425
3205
 
3426
- Greece = "greece",
3206
+ Greece: "greece",
3427
3207
 
3428
- Guatemala = "guatemala",
3208
+ Guatemala: "guatemala",
3429
3209
 
3430
- HongKong = "hongKong",
3210
+ HongKong: "hongKong",
3431
3211
 
3432
- Hungary = "hungary",
3212
+ Hungary: "hungary",
3433
3213
 
3434
- India = "india",
3214
+ India: "india",
3435
3215
 
3436
- Indonesia = "indonesia",
3216
+ Indonesia: "indonesia",
3437
3217
 
3438
- Ireland = "ireland",
3218
+ Ireland: "ireland",
3439
3219
 
3440
- Israel = "israel",
3220
+ Israel: "israel",
3441
3221
 
3442
- Italy = "italy",
3222
+ Italy: "italy",
3443
3223
 
3444
- Jordan = "jordan",
3224
+ Jordan: "jordan",
3445
3225
 
3446
- Kazakhstan = "kazakhstan",
3226
+ Kazakhstan: "kazakhstan",
3447
3227
 
3448
- Kenya = "kenya",
3228
+ Kenya: "kenya",
3449
3229
 
3450
- Kosovo = "kosovo",
3230
+ Kosovo: "kosovo",
3451
3231
 
3452
- Kuwait = "kuwait",
3232
+ Kuwait: "kuwait",
3453
3233
 
3454
- Latvia = "latvia",
3234
+ Latvia: "latvia",
3455
3235
 
3456
- Lithuania = "lithuania",
3236
+ Lithuania: "lithuania",
3457
3237
 
3458
- Malaysia = "malaysia",
3238
+ Malaysia: "malaysia",
3459
3239
 
3460
- Maldives = "maldives",
3240
+ Maldives: "maldives",
3461
3241
 
3462
- Malta = "malta",
3242
+ Malta: "malta",
3463
3243
 
3464
- Mauritius = "mauritius",
3244
+ Mauritius: "mauritius",
3465
3245
 
3466
- Mexico = "mexico",
3246
+ Mexico: "mexico",
3467
3247
 
3468
- Morocco = "morocco",
3248
+ Morocco: "morocco",
3469
3249
 
3470
- Netherlands = "netherlands",
3250
+ Netherlands: "netherlands",
3471
3251
 
3472
- NewZealand = "newZealand",
3252
+ NewZealand: "newZealand",
3473
3253
 
3474
- Nigeria = "nigeria",
3254
+ Nigeria: "nigeria",
3475
3255
 
3476
- Pakistan = "pakistan",
3256
+ Pakistan: "pakistan",
3477
3257
 
3478
- Panama = "panama",
3258
+ Panama: "panama",
3479
3259
 
3480
- Paraguay = "paraguay",
3260
+ Paraguay: "paraguay",
3481
3261
 
3482
- Philippines = "philippines",
3262
+ Philippines: "philippines",
3483
3263
 
3484
- Poland = "poland",
3264
+ Poland: "poland",
3485
3265
 
3486
- Portugal = "portugal",
3266
+ Portugal: "portugal",
3487
3267
 
3488
- PuertoRico = "puertoRico",
3268
+ PuertoRico: "puertoRico",
3489
3269
 
3490
- Qatar = "qatar",
3270
+ Qatar: "qatar",
3491
3271
 
3492
- Romania = "romania",
3272
+ Romania: "romania",
3493
3273
 
3494
- Russia = "russia",
3274
+ Russia: "russia",
3495
3275
 
3496
- SaudiArabia = "saudiArabia",
3276
+ SaudiArabia: "saudiArabia",
3497
3277
 
3498
- Serbia = "serbia",
3278
+ Serbia: "serbia",
3499
3279
 
3500
- Singapore = "singapore",
3280
+ Singapore: "singapore",
3501
3281
 
3502
- Slovakia = "slovakia",
3282
+ Slovakia: "slovakia",
3503
3283
 
3504
- Slovenia = "slovenia",
3284
+ Slovenia: "slovenia",
3505
3285
 
3506
- SouthAfrica = "southAfrica",
3286
+ SouthAfrica: "southAfrica",
3507
3287
 
3508
- Spain = "spain",
3288
+ Spain: "spain",
3509
3289
 
3510
- Sweden = "sweden",
3290
+ Sweden: "sweden",
3511
3291
 
3512
- Switzerland = "switzerland",
3292
+ Switzerland: "switzerland",
3513
3293
 
3514
- Taiwan = "taiwan",
3294
+ Taiwan: "taiwan",
3515
3295
 
3516
- Thailand = "thailand",
3296
+ Thailand: "thailand",
3517
3297
 
3518
- Tunisia = "tunisia",
3298
+ Tunisia: "tunisia",
3519
3299
 
3520
- Turkey = "turkey",
3300
+ Turkey: "turkey",
3521
3301
 
3522
- UAE = "uae",
3302
+ UAE: "uae",
3523
3303
 
3524
- Ganda = "gganda",
3304
+ Ganda: "gganda",
3525
3305
 
3526
- UK = "uk",
3306
+ UK: "uk",
3527
3307
 
3528
- Ukraine = "ukraine",
3308
+ Ukraine: "ukraine",
3529
3309
 
3530
- USA = "usa",
3310
+ USA: "usa",
3531
3311
 
3532
- Vietnam = "vietnam",
3312
+ Vietnam: "vietnam",
3533
3313
 
3534
- Brazil = "brazil",
3314
+ Brazil: "brazil",
3535
3315
 
3536
- Norway = "norway",
3316
+ Norway: "norway",
3537
3317
 
3538
- Oman = "oman",
3318
+ Oman: "oman",
3539
3319
 
3540
- Ecuador = "ecuador",
3320
+ Ecuador: "ecuador",
3541
3321
 
3542
- ElSalvador = "elSalvador",
3322
+ ElSalvador: "elSalvador",
3543
3323
 
3544
- SriLanka = "sriLanka",
3324
+ SriLanka: "sriLanka",
3545
3325
 
3546
- Peru = "peru",
3326
+ Peru: "peru",
3547
3327
 
3548
- Uruguay = "uruguay",
3328
+ Uruguay: "uruguay",
3549
3329
 
3550
- Bahamas = "bahamas",
3330
+ Bahamas: "bahamas",
3551
3331
 
3552
- Bermuda = "bermuda",
3332
+ Bermuda: "bermuda",
3553
3333
 
3554
- Bolivia = "bolivia",
3334
+ Bolivia: "bolivia",
3555
3335
 
3556
- China = "china",
3336
+ China: "china",
3557
3337
 
3558
- EuropeanUnion = "europeanUnion",
3338
+ EuropeanUnion: "europeanUnion",
3559
3339
 
3560
- Haiti = "haiti",
3340
+ Haiti: "haiti",
3561
3341
 
3562
- Honduras = "honduras",
3342
+ Honduras: "honduras",
3563
3343
 
3564
- Iceland = "iceland",
3344
+ Iceland: "iceland",
3565
3345
 
3566
- Japan = "japan",
3346
+ Japan: "japan",
3567
3347
 
3568
- Luxembourg = "luxembourg",
3348
+ Luxembourg: "luxembourg",
3569
3349
 
3570
- Montenegro = "montenegro",
3350
+ Montenegro: "montenegro",
3571
3351
 
3572
- Nicaragua = "nicaragua",
3352
+ Nicaragua: "nicaragua",
3573
3353
 
3574
- SouthKorea = "southKorea",
3354
+ SouthKorea: "southKorea",
3575
3355
 
3576
- Venezuela = "venezuela",
3356
+ Venezuela: "venezuela",
3577
3357
 
3578
- Afghanistan = "afghanistan",
3358
+ Afghanistan: "afghanistan",
3579
3359
 
3580
- AlandIslands = "alandIslands",
3360
+ AlandIslands: "alandIslands",
3581
3361
 
3582
- AmericanSamoa = "americanSamoa",
3362
+ AmericanSamoa: "americanSamoa",
3583
3363
 
3584
- Andorra = "andorra",
3364
+ Andorra: "andorra",
3585
3365
 
3586
- Angola = "angola",
3366
+ Angola: "angola",
3587
3367
 
3588
- Anguilla = "anguilla",
3368
+ Anguilla: "anguilla",
3589
3369
 
3590
- Antartica = "antarctica",
3370
+ Antartica: "antarctica",
3591
3371
 
3592
- AntiguaAndBarbuda = "antiguaAndBarbuda",
3372
+ AntiguaAndBarbuda: "antiguaAndBarbuda",
3593
3373
 
3594
- Armenia = "armenia",
3374
+ Armenia: "armenia",
3595
3375
 
3596
- Aruba = "aruba",
3376
+ Aruba: "aruba",
3597
3377
 
3598
- BailiwickOfGuernsey = "bailiwickOfGuernsey",
3378
+ BailiwickOfGuernsey: "bailiwickOfGuernsey",
3599
3379
 
3600
- BailiwickOfJersey = "bailiwickOfJersey",
3380
+ BailiwickOfJersey: "bailiwickOfJersey",
3601
3381
 
3602
- Barbados = "barbados",
3382
+ Barbados: "barbados",
3603
3383
 
3604
- Belarus = "belarus",
3384
+ Belarus: "belarus",
3605
3385
 
3606
- Belize = "belize",
3386
+ Belize: "belize",
3607
3387
 
3608
- Benin = "benin",
3388
+ Benin: "benin",
3609
3389
 
3610
- Bhutan = "bhutan",
3390
+ Bhutan: "bhutan",
3611
3391
 
3612
- BonaireSaintEustatiusAndSaba = "bonaireSaintEustatiusAndSaba",
3392
+ BonaireSaintEustatiusAndSaba: "bonaireSaintEustatiusAndSaba",
3613
3393
 
3614
- Botswana = "botswana",
3394
+ Botswana: "botswana",
3615
3395
 
3616
- BouvetIsland = "bouvetIsland",
3396
+ BouvetIsland: "bouvetIsland",
3617
3397
 
3618
- BritishIndianOceanTerritory = "britishIndianOceanTerritory",
3398
+ BritishIndianOceanTerritory: "britishIndianOceanTerritory",
3619
3399
 
3620
- BurkinaFaso = "burkinaFaso",
3400
+ BurkinaFaso: "burkinaFaso",
3621
3401
 
3622
- Burundi = "burundi",
3402
+ Burundi: "burundi",
3623
3403
 
3624
- Cameroon = "cameroon",
3404
+ Cameroon: "cameroon",
3625
3405
 
3626
- CapeVerde = "capeVerde",
3406
+ CapeVerde: "capeVerde",
3627
3407
 
3628
- CaribbeanNetherlands = "caribbeanNetherlands",
3408
+ CaribbeanNetherlands: "caribbeanNetherlands",
3629
3409
 
3630
- CaymanIslands = "caymanIslands",
3410
+ CaymanIslands: "caymanIslands",
3631
3411
 
3632
- CentralAfricanRepublic = "centralAfricanRepublic",
3412
+ CentralAfricanRepublic: "centralAfricanRepublic",
3633
3413
 
3634
- Chad = "chad",
3414
+ Chad: "chad",
3635
3415
 
3636
- ChristmasIsland = "christmasIsland",
3416
+ ChristmasIsland: "christmasIsland",
3637
3417
 
3638
- CocosIslands = "cocosIslands",
3418
+ CocosIslands: "cocosIslands",
3639
3419
 
3640
- Comoros = "comoros",
3420
+ Comoros: "comoros",
3641
3421
 
3642
- Congo = "congo",
3422
+ Congo: "congo",
3643
3423
 
3644
- CookIslands = "cookIslands",
3424
+ CookIslands: "cookIslands",
3645
3425
 
3646
- Cuba = "cuba",
3426
+ Cuba: "cuba",
3647
3427
 
3648
- Curacao = "curacao",
3428
+ Curacao: "curacao",
3649
3429
 
3650
- DemocraticRepublicOfTheCongo = "democraticRepublicOfTheCongo",
3430
+ DemocraticRepublicOfTheCongo: "democraticRepublicOfTheCongo",
3651
3431
 
3652
- Djibouti = "djibouti",
3432
+ Djibouti: "djibouti",
3653
3433
 
3654
- Dominica = "dominica",
3434
+ Dominica: "dominica",
3655
3435
 
3656
- EastTimor = "eastTimor",
3436
+ EastTimor: "eastTimor",
3657
3437
 
3658
- EquatorialGuinea = "equatorialGuinea",
3438
+ EquatorialGuinea: "equatorialGuinea",
3659
3439
 
3660
- Eritrea = "eritrea",
3440
+ Eritrea: "eritrea",
3661
3441
 
3662
- Ethiopia = "ethiopia",
3442
+ Ethiopia: "ethiopia",
3663
3443
 
3664
- FalklandIslands = "falklandIslands",
3444
+ FalklandIslands: "falklandIslands",
3665
3445
 
3666
- FaroeIslands = "faroeIslands",
3446
+ FaroeIslands: "faroeIslands",
3667
3447
 
3668
- FederatedStatesOfMicronesia = "federatedStatesOfMicronesia",
3448
+ FederatedStatesOfMicronesia: "federatedStatesOfMicronesia",
3669
3449
 
3670
- Fiji = "fiji",
3450
+ Fiji: "fiji",
3671
3451
 
3672
- FrenchGuiana = "frenchGuiana",
3452
+ FrenchGuiana: "frenchGuiana",
3673
3453
 
3674
- FrenchPolynesia = "frenchPolynesia",
3454
+ FrenchPolynesia: "frenchPolynesia",
3675
3455
 
3676
- FrenchSouthernTerritories = "frenchSouthernTerritories",
3456
+ FrenchSouthernTerritories: "frenchSouthernTerritories",
3677
3457
 
3678
- Gabon = "gabon",
3458
+ Gabon: "gabon",
3679
3459
 
3680
- Gambia = "gambia",
3460
+ Gambia: "gambia",
3681
3461
 
3682
- Gibraltar = "gibraltar",
3462
+ Gibraltar: "gibraltar",
3683
3463
 
3684
- Greenland = "greenland",
3464
+ Greenland: "greenland",
3685
3465
 
3686
- Grenada = "grenada",
3466
+ Grenada: "grenada",
3687
3467
 
3688
- Guadeloupe = "guadeloupe",
3468
+ Guadeloupe: "guadeloupe",
3689
3469
 
3690
- Guam = "guam",
3470
+ Guam: "guam",
3691
3471
 
3692
- Guinea = "guinea",
3472
+ Guinea: "guinea",
3693
3473
 
3694
- GuineaBissau = "guineaBissau",
3474
+ GuineaBissau: "guineaBissau",
3695
3475
 
3696
- Guyana = "guyana",
3476
+ Guyana: "guyana",
3697
3477
 
3698
- HeardIslandAndMcdonaldIslands = "heardIslandAndMcdonaldIslands",
3478
+ HeardIslandAndMcdonaldIslands: "heardIslandAndMcdonaldIslands",
3699
3479
 
3700
- Iran = "iran",
3480
+ Iran: "iran",
3701
3481
 
3702
- Iraq = "iraq",
3482
+ Iraq: "iraq",
3703
3483
 
3704
- IsleOfMan = "isleOfMan",
3484
+ IsleOfMan: "isleOfMan",
3705
3485
 
3706
- IvoryCoast = "ivoryCoast",
3486
+ IvoryCoast: "ivoryCoast",
3707
3487
 
3708
- Jamaica = "jamaica",
3488
+ Jamaica: "jamaica",
3709
3489
 
3710
- Kiribati = "kiribati",
3490
+ Kiribati: "kiribati",
3711
3491
 
3712
- Kyrgyzstan = "kyrgyzstan",
3492
+ Kyrgyzstan: "kyrgyzstan",
3713
3493
 
3714
- Laos = "laos",
3494
+ Laos: "laos",
3715
3495
 
3716
- Lebanon = "lebanon",
3496
+ Lebanon: "lebanon",
3717
3497
 
3718
- Lesotho = "lesotho",
3498
+ Lesotho: "lesotho",
3719
3499
 
3720
- Liberia = "liberia",
3500
+ Liberia: "liberia",
3721
3501
 
3722
- Libya = "libya",
3502
+ Libya: "libya",
3723
3503
 
3724
- Liechtenstein = "liechtenstein",
3504
+ Liechtenstein: "liechtenstein",
3725
3505
 
3726
- Macau = "macau",
3506
+ Macau: "macau",
3727
3507
 
3728
- Madagascar = "madagascar",
3508
+ Madagascar: "madagascar",
3729
3509
 
3730
- Malawi = "malawi",
3510
+ Malawi: "malawi",
3731
3511
 
3732
- Mali = "mali",
3512
+ Mali: "mali",
3733
3513
 
3734
- MarshallIslands = "marshallIslands",
3514
+ MarshallIslands: "marshallIslands",
3735
3515
 
3736
- Martinique = "martinique",
3516
+ Martinique: "martinique",
3737
3517
 
3738
- Mauritania = "mauritania",
3518
+ Mauritania: "mauritania",
3739
3519
 
3740
- Mayotte = "mayotte",
3520
+ Mayotte: "mayotte",
3741
3521
 
3742
- Moldova = "moldova",
3522
+ Moldova: "moldova",
3743
3523
 
3744
- Monaco = "monaco",
3524
+ Monaco: "monaco",
3745
3525
 
3746
- Mongolia = "mongolia",
3526
+ Mongolia: "mongolia",
3747
3527
 
3748
- Montserrat = "montserrat",
3528
+ Montserrat: "montserrat",
3749
3529
 
3750
- Mozambique = "mozambique",
3530
+ Mozambique: "mozambique",
3751
3531
 
3752
- Myanmar = "myanmar",
3532
+ Myanmar: "myanmar",
3753
3533
 
3754
- Namibia = "namibia",
3534
+ Namibia: "namibia",
3755
3535
 
3756
- Nauru = "nauru",
3536
+ Nauru: "nauru",
3757
3537
 
3758
- Nepal = "nepal",
3538
+ Nepal: "nepal",
3759
3539
 
3760
- NewCaledonia = "newCaledonia",
3540
+ NewCaledonia: "newCaledonia",
3761
3541
 
3762
- Niger = "niger",
3542
+ Niger: "niger",
3763
3543
 
3764
- Niue = "niue",
3544
+ Niue: "niue",
3765
3545
 
3766
- NorfolkIsland = "norfolkIsland",
3546
+ NorfolkIsland: "norfolkIsland",
3767
3547
 
3768
- NorthernCyprus = "northernCyprus",
3548
+ NorthernCyprus: "northernCyprus",
3769
3549
 
3770
- NorthernMarianaIslands = "northernMarianaIslands",
3550
+ NorthernMarianaIslands: "northernMarianaIslands",
3771
3551
 
3772
- NorthKorea = "northKorea",
3552
+ NorthKorea: "northKorea",
3773
3553
 
3774
- NorthMacedonia = "northMacedonia",
3554
+ NorthMacedonia: "northMacedonia",
3775
3555
 
3776
- Palau = "palau",
3556
+ Palau: "palau",
3777
3557
 
3778
- Palestine = "palestine",
3558
+ Palestine: "palestine",
3779
3559
 
3780
- PapuaNewGuinea = "papuaNewGuinea",
3560
+ PapuaNewGuinea: "papuaNewGuinea",
3781
3561
 
3782
- Pitcairn = "pitcairn",
3562
+ Pitcairn: "pitcairn",
3783
3563
 
3784
- Reunion = "reunion",
3564
+ Reunion: "reunion",
3785
3565
 
3786
- Rwanda = "rwanda",
3566
+ Rwanda: "rwanda",
3787
3567
 
3788
- SaintBarthelemy = "saintBarthelemy",
3568
+ SaintBarthelemy: "saintBarthelemy",
3789
3569
 
3790
- SaintHelenaAscensionAndTristianDaCunha = "saintHelenaAscensionAndTristianDaCunha",
3570
+ SaintHelenaAscensionAndTristianDaCunha:
3571
+ "saintHelenaAscensionAndTristianDaCunha",
3791
3572
 
3792
- SaintKittsAndNevis = "saintKittsAndNevis",
3573
+ SaintKittsAndNevis: "saintKittsAndNevis",
3793
3574
 
3794
- SaintLucia = "saintLucia",
3575
+ SaintLucia: "saintLucia",
3795
3576
 
3796
- SaintMartin = "saintMartin",
3577
+ SaintMartin: "saintMartin",
3797
3578
 
3798
- SaintPierreAndMiquelon = "saintPierreAndMiquelon",
3579
+ SaintPierreAndMiquelon: "saintPierreAndMiquelon",
3799
3580
 
3800
- SaintVincentAndTheGrenadines = "saintVincentAndTheGrenadines",
3581
+ SaintVincentAndTheGrenadines: "saintVincentAndTheGrenadines",
3801
3582
 
3802
- Samoa = "samoa",
3583
+ Samoa: "samoa",
3803
3584
 
3804
- SanMarino = "sanMarino",
3585
+ SanMarino: "sanMarino",
3805
3586
 
3806
- SaoTomeAndPrincipe = "saoTomeAndPrincipe",
3587
+ SaoTomeAndPrincipe: "saoTomeAndPrincipe",
3807
3588
 
3808
- Senegal = "senegal",
3589
+ Senegal: "senegal",
3809
3590
 
3810
- Seychelles = "seychelles",
3591
+ Seychelles: "seychelles",
3811
3592
 
3812
- SierraLeone = "sierraLeone",
3593
+ SierraLeone: "sierraLeone",
3813
3594
 
3814
- SintMaarten = "sintMaarten",
3595
+ SintMaarten: "sintMaarten",
3815
3596
 
3816
- SolomonIslands = "solomonIslands",
3597
+ SolomonIslands: "solomonIslands",
3817
3598
 
3818
- Somalia = "somalia",
3599
+ Somalia: "somalia",
3819
3600
 
3820
- SouthGeorgiaAndTheSouthSandwichIslands = "southGeorgiaAndTheSouthSandwichIslands",
3601
+ SouthGeorgiaAndTheSouthSandwichIslands:
3602
+ "southGeorgiaAndTheSouthSandwichIslands",
3821
3603
 
3822
- SouthSudan = "southSudan",
3604
+ SouthSudan: "southSudan",
3823
3605
 
3824
- Sudan = "sudan",
3606
+ Sudan: "sudan",
3825
3607
 
3826
- Suriname = "suriname",
3608
+ Suriname: "suriname",
3827
3609
 
3828
- SvalbardAndJanMayen = "svalbardAndJanMayen",
3610
+ SvalbardAndJanMayen: "svalbardAndJanMayen",
3829
3611
 
3830
- Eswatini = "eswatini",
3612
+ Eswatini: "eswatini",
3831
3613
 
3832
- Syria = "syria",
3614
+ Syria: "syria",
3833
3615
 
3834
- Tajikistan = "tajikistan",
3616
+ Tajikistan: "tajikistan",
3835
3617
 
3836
- Tanzania = "tanzania",
3618
+ Tanzania: "tanzania",
3837
3619
 
3838
- Togo = "togo",
3620
+ Togo: "togo",
3839
3621
 
3840
- Tokelau = "tokelau",
3622
+ Tokelau: "tokelau",
3841
3623
 
3842
- Tonga = "tonga",
3624
+ Tonga: "tonga",
3843
3625
 
3844
- TrinidadAndTobago = "trinidadAndTobago",
3626
+ TrinidadAndTobago: "trinidadAndTobago",
3845
3627
 
3846
- Turkmenistan = "turkmenistan",
3628
+ Turkmenistan: "turkmenistan",
3847
3629
 
3848
- TurksAndCaicosIslands = "turksAndCaicosIslands",
3630
+ TurksAndCaicosIslands: "turksAndCaicosIslands",
3849
3631
 
3850
- Tuvalu = "tuvalu",
3632
+ Tuvalu: "tuvalu",
3851
3633
 
3852
- UnitedStatesMinorOutlyingIslands = "unitedStatesMinorOutlyingIslands",
3634
+ UnitedStatesMinorOutlyingIslands: "unitedStatesMinorOutlyingIslands",
3853
3635
 
3854
- Uzbekistan = "uzbekistan",
3636
+ Uzbekistan: "uzbekistan",
3855
3637
 
3856
- Vanuatu = "vanuatu",
3638
+ Vanuatu: "vanuatu",
3857
3639
 
3858
- VaticanCity = "vaticanCity",
3640
+ VaticanCity: "vaticanCity",
3859
3641
 
3860
- VirginIslandsBritish = "virginIslandsBritish",
3642
+ VirginIslandsBritish: "virginIslandsBritish",
3861
3643
 
3862
- VirginIslandsUs = "virginIslandsUs",
3644
+ VirginIslandsOfTheUnitedStates: "virginIslandsOfTheUnitedStates",
3863
3645
 
3864
- WallisAndFutuna = "wallisAndFutuna",
3646
+ WallisAndFutuna: "wallisAndFutuna",
3865
3647
 
3866
- WesternSahara = "westernSahara",
3648
+ WesternSahara: "westernSahara",
3867
3649
 
3868
- Yemen = "yemen",
3650
+ Yemen: "yemen",
3869
3651
 
3870
- Yugoslavia = "yugoslavia",
3652
+ Yugoslavia: "yugoslavia",
3871
3653
 
3872
- Zambia = "zambia",
3654
+ Zambia: "zambia",
3873
3655
 
3874
- Zimbabwe = "zimbabwe",
3656
+ Zimbabwe: "zimbabwe",
3875
3657
 
3876
- SchengenArea = "schengenArea",
3658
+ SchengenArea: "schengenArea",
3659
+
3660
+ SaintThomasAndPrince: "saintThomasAndPrince",
3661
+ } as const;
3662
+
3663
+ export type CountryID = (typeof CountryID)[keyof typeof CountryID];
3877
3664
 
3878
- SaintThomasAndPrince = "saintThomasAndPrince",
3879
- }
3880
3665
  /**
3881
3666
  * Document region.
3882
3667
  */
3883
- export enum Region {
3884
- None = "none",
3668
+ export const RegionID = {
3669
+ None: "none",
3885
3670
 
3886
- Alabama = "alabama",
3671
+ Alabama: "alabama",
3887
3672
 
3888
- Alaska = "alaska",
3673
+ Alaska: "alaska",
3889
3674
 
3890
- Alberta = "alberta",
3675
+ Alberta: "alberta",
3891
3676
 
3892
- Arizona = "arizona",
3677
+ Arizona: "arizona",
3893
3678
 
3894
- Arkansas = "arkansas",
3679
+ Arkansas: "arkansas",
3895
3680
 
3896
- AustralianCapitalTerritory = "australianCapitalTerritory",
3681
+ AustralianCapitalTerritory: "australianCapitalTerritory",
3897
3682
 
3898
- BritishColumbia = "britishColumbia",
3683
+ BritishColumbia: "britishColumbia",
3899
3684
 
3900
- California = "california",
3685
+ California: "california",
3901
3686
 
3902
- Colorado = "colorado",
3687
+ Colorado: "colorado",
3903
3688
 
3904
- Connecticut = "connecticut",
3689
+ Connecticut: "connecticut",
3905
3690
 
3906
- Delaware = "delaware",
3691
+ Delaware: "delaware",
3907
3692
 
3908
- DistrictOfColumbia = "districtOfColumbia",
3693
+ DistrictOfColumbia: "districtOfColumbia",
3909
3694
 
3910
- Florida = "florida",
3695
+ Florida: "florida",
3911
3696
 
3912
- Georgia = "georgia",
3697
+ Georgia: "georgia",
3913
3698
 
3914
- Hawaii = "hawaii",
3699
+ Hawaii: "hawaii",
3915
3700
 
3916
- Idaho = "idaho",
3701
+ Idaho: "idaho",
3917
3702
 
3918
- Illinois = "illinois",
3703
+ Illinois: "illinois",
3919
3704
 
3920
- Indiana = "indiana",
3705
+ Indiana: "indiana",
3921
3706
 
3922
- Iowa = "iowa",
3707
+ Iowa: "iowa",
3923
3708
 
3924
- Kansas = "kansas",
3709
+ Kansas: "kansas",
3925
3710
 
3926
- Kentucky = "kentucky",
3711
+ Kentucky: "kentucky",
3927
3712
 
3928
- Louisiana = "louisiana",
3713
+ Louisiana: "louisiana",
3929
3714
 
3930
- Maine = "maine",
3715
+ Maine: "maine",
3931
3716
 
3932
- Manitoba = "manitoba",
3717
+ Manitoba: "manitoba",
3933
3718
 
3934
- Maryland = "maryland",
3719
+ Maryland: "maryland",
3935
3720
 
3936
- Massachusetts = "massachusetts",
3721
+ Massachusetts: "massachusetts",
3937
3722
 
3938
- Michigan = "michigan",
3723
+ Michigan: "michigan",
3939
3724
 
3940
- Minnesota = "minnesota",
3725
+ Minnesota: "minnesota",
3941
3726
 
3942
- Mississippi = "mississippi",
3727
+ Mississippi: "mississippi",
3943
3728
 
3944
- Missouri = "missouri",
3729
+ Missouri: "missouri",
3945
3730
 
3946
- Montana = "montana",
3731
+ Montana: "montana",
3947
3732
 
3948
- Nebraska = "nebraska",
3733
+ Nebraska: "nebraska",
3949
3734
 
3950
- Nevada = "nevada",
3735
+ Nevada: "nevada",
3951
3736
 
3952
- NewBrunswick = "newBrunswick",
3737
+ NewBrunswick: "newBrunswick",
3953
3738
 
3954
- NewHampshire = "newHampshire",
3739
+ NewHampshire: "newHampshire",
3955
3740
 
3956
- NewJersey = "newJersey",
3741
+ NewJersey: "newJersey",
3957
3742
 
3958
- NewMexico = "newMexico",
3743
+ NewMexico: "newMexico",
3959
3744
 
3960
- NewSouthWales = "newSouthWales",
3745
+ NewSouthWales: "newSouthWales",
3961
3746
 
3962
- NewYork = "newYork",
3747
+ NewYork: "newYork",
3963
3748
 
3964
- NorthernTerritory = "northernTerritory",
3749
+ NorthernTerritory: "northernTerritory",
3965
3750
 
3966
- NorthCarolina = "northCarolina",
3751
+ NorthCarolina: "northCarolina",
3967
3752
 
3968
- NorthDakota = "northDakota",
3753
+ NorthDakota: "northDakota",
3969
3754
 
3970
- NovaScotia = "novaScotia",
3755
+ NovaScotia: "novaScotia",
3971
3756
 
3972
- Ohio = "ohio",
3757
+ Ohio: "ohio",
3973
3758
 
3974
- Oklahoma = "oklahoma",
3759
+ Oklahoma: "oklahoma",
3975
3760
 
3976
- Ontario = "ontario",
3761
+ Ontario: "ontario",
3977
3762
 
3978
- Oregon = "oregon",
3763
+ Oregon: "oregon",
3979
3764
 
3980
- Pennsylvania = "pennsylvania",
3765
+ Pennsylvania: "pennsylvania",
3981
3766
 
3982
- Quebec = "quebec",
3767
+ Quebec: "quebec",
3983
3768
 
3984
- Queensland = "queensland",
3769
+ Queensland: "queensland",
3985
3770
 
3986
- RhodeIsland = "rhodeIsland",
3771
+ RhodeIsland: "rhodeIsland",
3987
3772
 
3988
- Saskatchewan = "saskatchewan",
3773
+ Saskatchewan: "saskatchewan",
3989
3774
 
3990
- SouthAustralia = "southAustralia",
3775
+ SouthAustralia: "southAustralia",
3991
3776
 
3992
- SouthCarolina = "southCarolina",
3777
+ SouthCarolina: "southCarolina",
3993
3778
 
3994
- SouthDakota = "southDakota",
3779
+ SouthDakota: "southDakota",
3995
3780
 
3996
- Tasmania = "tasmania",
3781
+ Tasmania: "tasmania",
3997
3782
 
3998
- Tennessee = "tennessee",
3783
+ Tennessee: "tennessee",
3999
3784
 
4000
- Texas = "texas",
3785
+ Texas: "texas",
4001
3786
 
4002
- Utah = "utah",
3787
+ Utah: "utah",
4003
3788
 
4004
- Vermont = "vermont",
3789
+ Vermont: "vermont",
4005
3790
 
4006
- Victoria = "victoria",
3791
+ Victoria: "victoria",
4007
3792
 
4008
- Virginia = "virginia",
3793
+ Virginia: "virginia",
4009
3794
 
4010
- Washington = "washington",
3795
+ Washington: "washington",
4011
3796
 
4012
- WesternAustralia = "westernAustralia",
3797
+ WesternAustralia: "westernAustralia",
4013
3798
 
4014
- WestVirginia = "westVirginia",
3799
+ WestVirginia: "westVirginia",
4015
3800
 
4016
- Wisconsin = "wisconsin",
3801
+ Wisconsin: "wisconsin",
4017
3802
 
4018
- Wyoming = "wyoming",
3803
+ Wyoming: "wyoming",
4019
3804
 
4020
- Yukon = "yukon",
3805
+ Yukon: "yukon",
4021
3806
 
4022
- CiudadDeMexico = "ciudadDeMexico",
3807
+ CiudadDeMexico: "ciudadDeMexico",
4023
3808
 
4024
- Jalisco = "jalisco",
3809
+ Jalisco: "jalisco",
4025
3810
 
4026
- NewfoundlandAndLabrador = "newfoundlandAndLabrador",
3811
+ NewfoundlandAndLabrador: "newfoundlandAndLabrador",
4027
3812
 
4028
- NuevoLeon = "nuevoLeon",
3813
+ NuevoLeon: "nuevoLeon",
4029
3814
 
4030
- BajaCalifornia = "bajaCalifornia",
3815
+ BajaCalifornia: "bajaCalifornia",
4031
3816
 
4032
- Chihuahua = "chihuahua",
3817
+ Chihuahua: "chihuahua",
4033
3818
 
4034
- Guanajuato = "guanajuato",
3819
+ Guanajuato: "guanajuato",
4035
3820
 
4036
- Guerrero = "guerrero",
3821
+ Guerrero: "guerrero",
4037
3822
 
4038
- Mexico = "mexico",
3823
+ Mexico: "mexico",
4039
3824
 
4040
- Michoacan = "michoacan",
3825
+ Michoacan: "michoacan",
4041
3826
 
4042
- NewYorkCity = "newYorkCity",
3827
+ NewYorkCity: "newYorkCity",
4043
3828
 
4044
- Tamaulipas = "tamaulipas",
3829
+ Tamaulipas: "tamaulipas",
4045
3830
 
4046
- Veracruz = "veracruz",
3831
+ Veracruz: "veracruz",
4047
3832
 
4048
- Chiapas = "chiapas",
3833
+ Chiapas: "chiapas",
4049
3834
 
4050
- Coahuila = "coahuila",
3835
+ Coahuila: "coahuila",
4051
3836
 
4052
- Durago = "durango",
3837
+ Durago: "durango",
4053
3838
 
4054
- GuerreroCocula = "guerreroCocula",
3839
+ GuerreroCocula: "guerreroCocula",
4055
3840
 
4056
- GuerreroJuchitan = "guerreroJuchitan",
3841
+ GuerreroJuchitan: "guerreroJuchitan",
4057
3842
 
4058
- GuerreroTepecoacuilco = "guerreroTepecoacuilco",
3843
+ GuerreroTepecoacuilco: "guerreroTepecoacuilco",
4059
3844
 
4060
- GuerreroTlacoapa = "guerreroTlacoapa",
3845
+ GuerreroTlacoapa: "guerreroTlacoapa",
4061
3846
 
4062
- Gujarat = "gujarat",
3847
+ Gujarat: "gujarat",
4063
3848
 
4064
- Hidalgo = "hidalgo",
3849
+ Hidalgo: "hidalgo",
4065
3850
 
4066
- Karnataka = "karnataka",
3851
+ Karnataka: "karnataka",
4067
3852
 
4068
- Kerala = "kerala",
3853
+ Kerala: "kerala",
4069
3854
 
4070
- KhyberPakhtunkhwa = "khyberPakhtunkhwa",
3855
+ KhyberPakhtunkhwa: "khyberPakhtunkhwa",
4071
3856
 
4072
- MadhyaPradesh = "madhyaPradesh",
3857
+ MadhyaPradesh: "madhyaPradesh",
4073
3858
 
4074
- Maharashtra = "maharashtra",
3859
+ Maharashtra: "maharashtra",
4075
3860
 
4076
- Morelos = "morelos",
3861
+ Morelos: "morelos",
4077
3862
 
4078
- Nayarit = "nayarit",
3863
+ Nayarit: "nayarit",
4079
3864
 
4080
- Oaxaca = "oaxaca",
3865
+ Oaxaca: "oaxaca",
4081
3866
 
4082
- Puebla = "puebla",
3867
+ Puebla: "puebla",
4083
3868
 
4084
- Punjab = "punjab",
3869
+ Punjab: "punjab",
4085
3870
 
4086
- Queretaro = "queretaro",
3871
+ Queretaro: "queretaro",
4087
3872
 
4088
- SanLuisPotosi = "sanLuisPotosi",
3873
+ SanLuisPotosi: "sanLuisPotosi",
4089
3874
 
4090
- Sinaloa = "sinaloa",
3875
+ Sinaloa: "sinaloa",
4091
3876
 
4092
- Sonora = "sonora",
3877
+ Sonora: "sonora",
4093
3878
 
4094
- Tabasco = "tabasco",
3879
+ Tabasco: "tabasco",
4095
3880
 
4096
- TamilNadu = "tamilNadu",
3881
+ TamilNadu: "tamilNadu",
4097
3882
 
4098
- Yucatan = "yucatan",
3883
+ Yucatan: "yucatan",
4099
3884
 
4100
- Zacatecas = "zacatecas",
3885
+ Zacatecas: "zacatecas",
4101
3886
 
4102
- Aguascalientes = "aguascalientes",
3887
+ Aguascalientes: "aguascalientes",
4103
3888
 
4104
- BajaCaliforniaSur = "bajaCaliforniaSur",
3889
+ BajaCaliforniaSur: "bajaCaliforniaSur",
4105
3890
 
4106
- Campeche = "campeche",
3891
+ Campeche: "campeche",
4107
3892
 
4108
- Colima = "colima",
3893
+ Colima: "colima",
4109
3894
 
4110
- QuintanaRooBenitoJuarez = "quintanaRooBenitoJuarez",
3895
+ QuintanaRooBenitoJuarez: "quintanaRooBenitoJuarez",
4111
3896
 
4112
- QuintanaRoo = "quintanaRoo",
3897
+ QuintanaRoo: "quintanaRoo",
4113
3898
 
4114
- QuintanaRooSolidaridad = "quintanaRooSolidaridad",
3899
+ QuintanaRooSolidaridad: "quintanaRooSolidaridad",
4115
3900
 
4116
- Tlaxcala = "tlaxcala",
3901
+ Tlaxcala: "tlaxcala",
4117
3902
 
4118
- QuintanaRooCozumel = "quintanaRooCozumel",
3903
+ QuintanaRooCozumel: "quintanaRooCozumel",
4119
3904
 
4120
- SanPaolo = "saoPaolo",
3905
+ SaoPaolo: "saoPaolo",
4121
3906
 
4122
- RioDeJaniero = "rioDeJaneiro",
3907
+ RioDeJaneiro: "rioDeJaneiro",
4123
3908
 
4124
- RioGrandeDoSul = "rioGrandeDoSul",
3909
+ RioGrandeDoSul: "rioGrandeDoSul",
4125
3910
 
4126
- NorthWestTerritories = "northWestTerritories",
3911
+ NorthwestTerritories: "northwestTerritories",
4127
3912
 
4128
- Nunavut = "nunavut",
3913
+ Nunavut: "nunavut",
4129
3914
 
4130
- PrinceEdwardIsland = "princeEdwardIsland",
3915
+ PrinceEdwardIsland: "princeEdwardIsland",
4131
3916
 
4132
- DistritoFederal = "distritoFederal",
3917
+ DistritoFederal: "distritoFederal",
4133
3918
 
4134
- Maranhao = "maranhao",
3919
+ Maranhao: "maranhao",
4135
3920
 
4136
- MatoGrosso = "matoGrosso",
3921
+ MatoGrosso: "matoGrosso",
4137
3922
 
4138
- MinasGerais = "minasGerais",
3923
+ MinasGerais: "minasGerais",
4139
3924
 
4140
- Para = "para",
3925
+ Para: "para",
4141
3926
 
4142
- Parana = "parana",
3927
+ Parana: "parana",
4143
3928
 
4144
- Pernambuco = "pernambuco",
3929
+ Pernambuco: "pernambuco",
4145
3930
 
4146
- SantaCatarina = "santaCatarina",
3931
+ SantaCatarina: "santaCatarina",
4147
3932
 
4148
- AndhraPradesh = "andhraPradesh",
3933
+ AndhraPradesh: "andhraPradesh",
4149
3934
 
4150
- Ceara = "ceara",
3935
+ Ceara: "ceara",
4151
3936
 
4152
- Goias = "goias",
3937
+ Goias: "goias",
4153
3938
 
4154
- GuerreroAcapulcoDeJuarez = "guerreroAcapulcoDeJuarez",
3939
+ GuerreroAcapulcoDeJuarez: "guerreroAcapulcoDeJuarez",
4155
3940
 
4156
- Haryana = "haryana",
3941
+ Haryana: "haryana",
4157
3942
 
4158
- Sergipe = "sergipe",
3943
+ Sergipe: "sergipe",
4159
3944
 
4160
- Alagos = "alagos",
3945
+ Alagoas: "alagoas",
4161
3946
 
4162
- Bangsamoro = "bangsamoro",
3947
+ Bangsamoro: "bangsamoro",
4163
3948
 
4164
- Telangana = "telangana",
3949
+ Telangana: "telangana",
4165
3950
 
4166
- Acre = "acre",
3951
+ Acre: "acre",
4167
3952
 
4168
- EspiritoSanto = "espiritoSanto",
3953
+ EspiritoSanto: "espiritoSanto",
4169
3954
 
4170
- MatoGrossoDoSul = "matoGrossoDoSul",
3955
+ MatoGrossoDoSul: "matoGrossoDoSul",
4171
3956
 
4172
- Paraiba = "paraiba",
3957
+ Paraiba: "paraiba",
4173
3958
 
4174
- Piaui = "piaui",
3959
+ Piaui: "piaui",
4175
3960
 
4176
- RioGrandeDoNorte = "rioGrandeDoNorte",
3961
+ RioGrandeDoNorte: "rioGrandeDoNorte",
4177
3962
 
4178
- Tocantins = "tocantins",
3963
+ Tocantins: "tocantins",
4179
3964
 
4180
- Odisha = "odisha",
3965
+ Odisha: "odisha",
4181
3966
 
4182
- Uttarakhand = "uttarakhand",
4183
- }
3967
+ Uttarakhand: "uttarakhand",
3968
+ } as const;
3969
+
3970
+ export type RegionID = (typeof RegionID)[keyof typeof RegionID];
4184
3971
 
4185
3972
  /**
4186
3973
  * Document type.
4187
3974
  *
4188
3975
  */
4189
- export enum DocumentType {
4190
- None = "none",
3976
+ export const DocumentTypeID = {
3977
+ None: "none",
4191
3978
 
4192
- ConsularId = "consularId",
3979
+ ConsularId: "consularId",
4193
3980
 
4194
- Dl = "dl",
3981
+ Dl: "dl",
4195
3982
 
4196
- DlPublicServicesCard = "dlPublicServicesCard",
3983
+ DlPublicServicesCard: "dlPublicServicesCard",
4197
3984
 
4198
- EmploymentPass = "employmentPass",
3985
+ EmploymentPass: "employmentPass",
4199
3986
 
4200
- FinCard = "finCard",
3987
+ FinCard: "finCard",
4201
3988
 
4202
- Id = "id",
3989
+ Id: "id",
4203
3990
 
4204
- MultipurposeId = "multipurposeId",
3991
+ MultipurposeId: "multipurposeId",
4205
3992
 
4206
- MyKad = "myKad",
3993
+ MyKad: "myKad",
4207
3994
 
4208
- MyKid = "myKid",
3995
+ MyKid: "myKid",
4209
3996
 
4210
- MyPr = "myPR",
3997
+ MyPr: "myPR",
4211
3998
 
4212
- MyTentera = "myTentera",
3999
+ MyTentera: "myTentera",
4213
4000
 
4214
- PanCard = "panCard",
4001
+ PanCard: "panCard",
4215
4002
 
4216
- ProfessionalId = "professionalId",
4003
+ ProfessionalId: "professionalId",
4217
4004
 
4218
- PublicServicesCard = "publicServicesCard",
4005
+ PublicServicesCard: "publicServicesCard",
4219
4006
 
4220
- ResidencePermit = "residencePermit",
4007
+ ResidencePermit: "residencePermit",
4221
4008
 
4222
- ResidentId = "residentId",
4009
+ ResidentId: "residentId",
4223
4010
 
4224
- TemporaryResidencePermit = "temporaryResidencePermit",
4011
+ TemporaryResidencePermit: "temporaryResidencePermit",
4225
4012
 
4226
- VoterId = "voterId",
4013
+ VoterId: "voterId",
4227
4014
 
4228
- WorkPermit = "workPermit",
4015
+ WorkPermit: "workPermit",
4229
4016
 
4230
- IKad = "iKad",
4017
+ IKad: "iKad",
4231
4018
 
4232
- MilitaryId = "militaryId",
4019
+ MilitaryId: "militaryId",
4233
4020
 
4234
- MyKas = "myKas",
4021
+ MyKas: "myKas",
4235
4022
 
4236
- DocialSecurityCard = "docialSecurityCard",
4023
+ DocialSecurityCard: "docialSecurityCard",
4237
4024
 
4238
- HealthInsuranceCard = "healthInsuranceCard",
4025
+ HealthInsuranceCard: "healthInsuranceCard",
4239
4026
 
4240
- Passport = "passport",
4027
+ Passport: "passport",
4241
4028
 
4242
- SPass = "sPass",
4029
+ SPass: "sPass",
4243
4030
 
4244
- AddressCard = "addressCard",
4031
+ AddressCard: "addressCard",
4245
4032
 
4246
- AlienId = "alienId",
4033
+ AlienId: "alienId",
4247
4034
 
4248
- AlienPassport = "alienPassport",
4035
+ AlienPassport: "alienPassport",
4249
4036
 
4250
- GreenCard = "greenCard",
4037
+ GreenCard: "greenCard",
4251
4038
 
4252
- MinorsId = "minorsId",
4039
+ MinorsId: "minorsId",
4253
4040
 
4254
- PostalId = "postalId",
4041
+ PostalId: "postalId",
4255
4042
 
4256
- ProfessionalDl = "professionalDl",
4043
+ ProfessionalDl: "professionalDl",
4257
4044
 
4258
- TaxId = "taxId",
4045
+ TaxId: "taxId",
4259
4046
 
4260
- WeaponPermit = "weaponPermit",
4047
+ WeaponPermit: "weaponPermit",
4261
4048
 
4262
- Visa = "visa",
4049
+ Visa: "visa",
4263
4050
 
4264
- BorderCrossingCard = "borderCrossingCard",
4051
+ BorderCrossingCard: "borderCrossingCard",
4265
4052
 
4266
- DriverCard = "driverCard",
4053
+ DriverCard: "driverCard",
4267
4054
 
4268
- GlobalEntryCard = "globalEntryCard",
4055
+ GlobalEntryCard: "globalEntryCard",
4269
4056
 
4270
- MyPolis = "mypolis",
4057
+ MyPolis: "mypolis",
4271
4058
 
4272
- NexusCard = "nexusCard",
4059
+ NexusCard: "nexusCard",
4273
4060
 
4274
- PassportCard = "passportCard",
4061
+ PassportCard: "passportCard",
4275
4062
 
4276
- ProofOfAgeCard = "proofOfAgeCard",
4063
+ ProofOfAgeCard: "proofOfAgeCard",
4277
4064
 
4278
- RefugeeId = "refugeeId",
4065
+ RefugeeId: "refugeeId",
4279
4066
 
4280
- TribalId = "tribalId",
4067
+ TribalId: "tribalId",
4281
4068
 
4282
- VeteranId = "veteranId",
4069
+ VeteranId: "veteranId",
4283
4070
 
4284
- CitizenshipCertificate = "citizenshipCertificate",
4071
+ CitizenshipCertificate: "citizenshipCertificate",
4285
4072
 
4286
- MyNumberCard = "myNumberCard",
4073
+ MyNumberCard: "myNumberCard",
4287
4074
 
4288
- ConsularPassport = "consularPassport",
4075
+ ConsularPassport: "consularPassport",
4289
4076
 
4290
- MinorsPassport = "minorsPassport",
4077
+ MinorsPassport: "minorsPassport",
4291
4078
 
4292
- MinorsPublicServicesCard = "minorsPublicServicesCard",
4079
+ MinorsPublicServicesCard: "minorsPublicServicesCard",
4293
4080
 
4294
- DrivingPriviligeCard = "drivingPriviligeCard",
4081
+ DrivingPrivilegeCard: "drivingPrivilegeCard",
4295
4082
 
4296
- AsylumRequest = "asylumRequest",
4083
+ AsylumRequest: "asylumRequest",
4297
4084
 
4298
- DriverQualificationCard = "driverQualificationCard",
4085
+ DriverQualificationCard: "driverQualificationCard",
4299
4086
 
4300
- ProvisionalDl = "provisionalDl",
4087
+ ProvisionalDl: "provisionalDl",
4301
4088
 
4302
- RefugeePassport = "refugeePassport",
4089
+ RefugeePassport: "refugeePassport",
4303
4090
 
4304
- SpecialId = "specialId",
4091
+ SpecialId: "specialId",
4305
4092
 
4306
- UniformedServicesId = "uniformedServicesId",
4093
+ UniformedServicesId: "uniformedServicesId",
4307
4094
 
4308
- ImmigrantVisa = "immigrantVisa",
4095
+ ImmigrantVisa: "immigrantVisa",
4309
4096
 
4310
- ConsularVoterId = "consularVoterId",
4097
+ ConsularVoterId: "consularVoterId",
4311
4098
 
4312
- TwicCard = "twicCard",
4099
+ TwicCard: "twicCard",
4313
4100
 
4314
- ExitEntryPermit = "exitEntryPermit",
4101
+ ExitEntryPermit: "exitEntryPermit",
4315
4102
 
4316
- MainlandTravelPermitTaiwan = "mainlandTravelPermitTaiwan",
4103
+ MainlandTravelPermitTaiwan: "mainlandTravelPermitTaiwan",
4317
4104
 
4318
- NbiClearance = "nbiClearance",
4105
+ NbiClearance: "nbiClearance",
4319
4106
 
4320
- ProofOfRegistration = "proofOfRegistration",
4107
+ ProofOfRegistration: "proofOfRegistration",
4321
4108
 
4322
- TemporaryProtectionPermit = "temporaryProtectionPermit",
4109
+ TemporaryProtectionPermit: "temporaryProtectionPermit",
4323
4110
 
4324
- AfghanCitizenCard = "afghanCitizenCard",
4111
+ AfghanCitizenCard: "afghanCitizenCard",
4325
4112
 
4326
- EId = "eId",
4113
+ Eid: "eid",
4327
4114
 
4328
- Pass = "pass",
4115
+ Pass: "pass",
4329
4116
 
4330
- SisId = "sisId",
4117
+ SisId: "sisId",
4331
4118
 
4332
- AsicCard = "asicCard",
4119
+ AsicCard: "asicCard",
4333
4120
 
4334
- BidoonCard = "bidoonCard",
4121
+ BidoonCard: "bidoonCard",
4335
4122
 
4336
- InterimHealthInsuranceCard = "interimHealthInsuranceCard",
4123
+ InterimHealthInsuranceCard: "interimHealthInsuranceCard",
4337
4124
 
4338
- NonVoterId = "nonVoterId",
4125
+ NonVoterId: "nonVoterId",
4339
4126
 
4340
- ReciprocalHealthInsuranceCard = "reciprocalHealthInsuranceCard",
4127
+ ReciprocalHealthInsuranceCard: "reciprocalHealthInsuranceCard",
4341
4128
 
4342
- VehicleRegistration = "vehicleRegistration",
4129
+ VehicleRegistration: "vehicleRegistration",
4343
4130
 
4344
- EsaadCard = "esaadCard",
4131
+ EsaadCard: "esaadCard",
4345
4132
 
4346
- RegistrationCertificate = "registrationCertificate",
4133
+ RegistrationCertificate: "registrationCertificate",
4347
4134
 
4348
- MedicalMarijuanaId = "medicalMarijuanaId",
4135
+ MedicalMarijuanaId: "medicalMarijuanaId",
4349
4136
 
4350
- NonCardTribalId = "nonCardTribalId",
4137
+ NonCardTribalId: "nonCardTribalId",
4351
4138
 
4352
- DiplomaticId = "diplomaticId",
4139
+ DiplomaticId: "diplomaticId",
4353
4140
 
4354
- EmergencyPassport = "emergencyPassport",
4141
+ EmergencyPassport: "emergencyPassport",
4355
4142
 
4356
- TemporaryPassport = "temporaryPassport",
4143
+ TemporaryPassport: "temporaryPassport",
4357
4144
 
4358
- MetisFederationCard = "metisFederationCard",
4145
+ MetisFederationCard: "metisFederationCard",
4359
4146
 
4360
- SocialSecurityCard = "socialSecurityCard",
4147
+ SocialSecurityCard: "socialSecurityCard",
4361
4148
 
4362
- AdrCertificate = "adrCertificate",
4149
+ AdrCertificate: "adrCertificate",
4363
4150
 
4364
- NinCard = "ninCard",
4151
+ NinCard: "ninCard",
4365
4152
 
4366
- MysssCard = "mysssCard",
4153
+ MysssCard: "mysssCard",
4367
4154
 
4368
- GendarmerieId = "gendarmerieId",
4155
+ GendarmerieId: "gendarmerieId",
4369
4156
 
4370
- PoliceId = "policeId",
4371
- }
4157
+ PoliceId: "policeId",
4372
4158
 
4159
+ OriginCard: "originCard",
4160
+ } as const;
4161
+ export type DocumentTypeID = (typeof DocumentTypeID)[keyof typeof DocumentTypeID];
4373
4162
  /**
4374
4163
  * Represents all possible field types that can be extracted from the document.
4375
4164
  *
4376
4165
  */
4377
- export enum FieldType {
4378
- AdditionalAddressInformation = "additionalAddressInformation",
4166
+ export const FieldType = {
4167
+ AdditionalAddressInformation: "additionalAddressInformation",
4379
4168
 
4380
- AdditionalNameInformation = "additionalNameInformation",
4169
+ AdditionalNameInformation: "additionalNameInformation",
4381
4170
 
4382
- AdditionalOptionalAddressInformation = "additionalOptionalAddressInformation",
4171
+ AdditionalOptionalAddressInformation: "additionalOptionalAddressInformation",
4383
4172
 
4384
- AdditionalPersonalIdNumber = "additionalPersonalIdNumber",
4173
+ AdditionalPersonalIdNumber: "additionalPersonalIdNumber",
4385
4174
 
4386
- Address = "address",
4175
+ Address: "address",
4387
4176
 
4388
- ClassEffectiveDate = "classEffectiveDate",
4177
+ ClassEffectiveDate: "classEffectiveDate",
4389
4178
 
4390
- ClassExpiryDate = "classExpiryDate",
4179
+ ClassExpiryDate: "classExpiryDate",
4391
4180
 
4392
- Conditions = "conditions",
4181
+ Conditions: "conditions",
4393
4182
 
4394
- DateOfBirth = "dateOfBirth",
4183
+ DateOfBirth: "dateOfBirth",
4395
4184
 
4396
- DateOfExpiry = "dateOfExpiry",
4185
+ DateOfExpiry: "dateOfExpiry",
4397
4186
 
4398
- DateOfIssue = "dateOfIssue",
4187
+ DateOfIssue: "dateOfIssue",
4399
4188
 
4400
- DocumentAdditionalNumber = "documentAdditionalNumber",
4189
+ DocumentAdditionalNumber: "documentAdditionalNumber",
4401
4190
 
4402
- DocumentOptionalAdditionalNumber = "documentOptionalAdditionalNumber",
4191
+ DocumentOptionalAdditionalNumber: "documentOptionalAdditionalNumber",
4403
4192
 
4404
- DocumentNumber = "documentNumber",
4193
+ DocumentNumber: "documentNumber",
4405
4194
 
4406
- Employer = "employer",
4195
+ Employer: "employer",
4407
4196
 
4408
- Endorsements = "endorsements",
4197
+ Endorsements: "endorsements",
4409
4198
 
4410
- FathersName = "fathersName",
4199
+ FathersName: "fathersName",
4411
4200
 
4412
- FirstName = "firstName",
4201
+ FirstName: "firstName",
4413
4202
 
4414
- FullName = "fullName",
4203
+ FullName: "fullName",
4415
4204
 
4416
- IssuingAuthority = "issuingAuthority",
4205
+ IssuingAuthority: "issuingAuthority",
4417
4206
 
4418
- LastName = "lastName",
4207
+ LastName: "lastName",
4419
4208
 
4420
- LicenseType = "licenceType",
4209
+ LicenseType: "licenceType",
4421
4210
 
4422
- LocalizedName = "localizedName",
4211
+ LocalizedName: "localizedName",
4423
4212
 
4424
- MaritalStatus = "maritalStatus",
4213
+ MaritalStatus: "maritalStatus",
4425
4214
 
4426
- MothersName = "mothersName",
4215
+ MothersName: "mothersName",
4427
4216
 
4428
- Mrz = "mrz",
4217
+ Mrz: "mrz",
4429
4218
 
4430
- Nationality = "nationality",
4219
+ Nationality: "nationality",
4431
4220
 
4432
- PersonalIdNumber = "personalIdNumber",
4221
+ PersonalIdNumber: "personalIdNumber",
4433
4222
 
4434
- PlaceOfBirth = "placeOfBirth",
4223
+ PlaceOfBirth: "placeOfBirth",
4435
4224
 
4436
- Profession = "profession",
4225
+ Profession: "profession",
4437
4226
 
4438
- Race = "race",
4227
+ Race: "race",
4439
4228
 
4440
- Religion = "religion",
4229
+ Religion: "religion",
4441
4230
 
4442
- ResidentialStatus = "residentialStatus",
4231
+ ResidentialStatus: "residentialStatus",
4443
4232
 
4444
- Restriction = "restrictions",
4233
+ Restriction: "restrictions",
4445
4234
 
4446
- Sex = "sex",
4235
+ Sex: "sex",
4447
4236
 
4448
- VehicleClass = "vehicleClass",
4237
+ VehicleClass: "vehicleClass",
4449
4238
 
4450
- BloodType = "bloodType",
4239
+ BloodType: "bloodType",
4451
4240
 
4452
- Sponsor = "sponsor",
4241
+ Sponsor: "sponsor",
4453
4242
 
4454
- VisaType = "visaType",
4243
+ VisaType: "visaType",
4455
4244
 
4456
- DocumentSubtype = "documentSubtype",
4245
+ DocumentSubtype: "documentSubtype",
4457
4246
 
4458
- Remarks = "remarks",
4247
+ Remarks: "remarks",
4459
4248
 
4460
- ResidencePermitType = "residencePermitType",
4249
+ ResidencePermitType: "residencePermitType",
4461
4250
 
4462
- ManufacturingYear = "manufacturingYear",
4251
+ ManufacturingYear: "manufacturingYear",
4463
4252
 
4464
- VehicleType = "vehicleType",
4253
+ VehicleType: "vehicleType",
4465
4254
 
4466
- DependentDateOfBirth = "dependentDateOfBirth",
4255
+ DependentDateOfBirth: "dependentDateOfBirth",
4467
4256
 
4468
- DependentSex = "dependentSex",
4257
+ DependentSex: "dependentSex",
4469
4258
 
4470
- DependentDocumentNumber = "dependentDocumentNumber",
4259
+ DependentDocumentNumber: "dependentDocumentNumber",
4471
4260
 
4472
- DependentFullName = "dependentFullName",
4261
+ DependentFullName: "dependentFullName",
4473
4262
 
4474
- EligibilityCategory = "eligibilityCategory",
4263
+ EligibilityCategory: "eligibilityCategory",
4475
4264
 
4476
- SpecificDocumentValidity = "specificDocumentValidity",
4265
+ SpecificDocumentValidity: "specificDocumentValidity",
4477
4266
 
4478
- VehicleOwner = "vehicleOwner",
4267
+ VehicleOwner: "vehicleOwner",
4479
4268
 
4480
- nationalInsuranceNumber = "nationalInsuranceNumber",
4269
+ nationalInsuranceNumber: "nationalInsuranceNumber",
4481
4270
 
4482
- CountryCode = "countryCode",
4271
+ CountryCode: "countryCode",
4483
4272
 
4484
- CertificateNumber = "certificateNumber",
4273
+ CertificateNumber: "certificateNumber",
4485
4274
 
4486
- MunicipalityOfRegistration = "municipalityOfRegistration",
4275
+ MunicipalityOfRegistration: "municipalityOfRegistration",
4487
4276
 
4488
- LocalityCode = "localityCode",
4277
+ LocalityCode: "localityCode",
4489
4278
 
4490
- MaidenName = "maidenName",
4279
+ MaidenName: "maidenName",
4491
4280
 
4492
- StateCode = "stateCode",
4281
+ StateCode: "stateCode",
4493
4282
 
4494
- DateOfEntry = "dateOfEntry",
4283
+ DateOfEntry: "dateOfEntry",
4495
4284
 
4496
- MunicipalityCode = "municipalityCode",
4285
+ MunicipalityCode: "municipalityCode",
4497
4286
 
4498
- PollingStationCode = "pollingStationCode",
4287
+ PollingStationCode: "pollingStationCode",
4499
4288
 
4500
- SectionCode = "sectionCode",
4289
+ SectionCode: "sectionCode",
4501
4290
 
4502
- RegistrationCenterCode = "registrationCenterCode",
4291
+ RegistrationCenterCode: "registrationCenterCode",
4503
4292
 
4504
- StateName = "stateName",
4293
+ StateName: "stateName",
4505
4294
 
4506
- EffectiveDate = "effectiveDate",
4295
+ EffectiveDate: "effectiveDate",
4507
4296
 
4508
- ParentsLastName = "parentsLastName",
4297
+ ParentsLastName: "parentsLastName",
4509
4298
 
4510
- ParentsLastName2 = "parentsLastName2",
4299
+ ParentsFirstName: "parentsFirstName",
4511
4300
 
4512
- ParentsFirstName = "parentsFirstName",
4301
+ WorkRestriction: "workRestriction",
4513
4302
 
4514
- ParentsFirstName2 = "parentsFirstName2",
4303
+ SocialSecurityStatus: "socialSecurityStatus",
4515
4304
 
4516
- WorkRestriction = "workRestriction",
4305
+ LegalStatus: "legalStatus",
4517
4306
 
4518
- SocialSecurityStatus = "socialSecurityStatus",
4307
+ HusbandName: "husbandName",
4519
4308
 
4520
- LegalStatus = "legalStatus",
4309
+ CardAccessNumber: "cardAccessNumber",
4521
4310
 
4522
- HusbandName = "husbandName",
4311
+ ParentFullName: "parentFullName",
4523
4312
 
4524
- ChinPermanentExpiry = "chinPermanentExpiry",
4525
- }
4313
+ Ethnicity: "ethnicity",
4314
+ } as const;
4315
+
4316
+ export type FieldType = (typeof FieldType)[keyof typeof FieldType];
4526
4317
 
4527
4318
  /** An enum indicating preffered camera position for document capturing. */
4528
- export enum PreferredCamera {
4319
+ export type PreferredCamera =
4529
4320
  /**
4530
4321
  * Use the back-facing camera
4531
4322
  *
4532
4323
  * This is the default value
4533
4324
  */
4534
- Back = "back",
4325
+ | "back"
4535
4326
 
4536
4327
  /**
4537
4328
  * Use the front-facing camera
4538
4329
  *
4539
4330
  */
4540
- Front = "front",
4541
- }
4331
+ | "front";