BlinkID
Toggle table of contents
androidJvm
Platform filter
androidJvm
Switch theme
BlinkID
blinkid-core
com.
microblink.
blinkid.
core
Blink
Id
Sdk
Companion
Blink
Id
Sdk
Settings
com.
microblink.
blinkid.
core.
result
Address
Detailed
Info
Companion
Alphabet
Type
Latin
Arabic
Cyrillic
Greek
Data
Match
Field
State
Data
Match
Field
Type
Date
Of
Birth
Date
Of
Expiry
Document
Number
Document
Additional
Number
Document
Optional
Additional
Number
Personal
Id
Number
Data
Match
Result
Companion
Data
Match
State
Not
Performed
Failed
Success
Date
Result
Companion
Dependent
Info
Companion
Document
Image
Color
Status
Not
Available
Black
And
White
Color
Count
Document
Orientation
Not
Available
Horizontal
Vertical
Document
Rotation
Not
Available
Zero
Clockwise90
Counter
Clockwise90
Upside
Down
Driver
License
Detailed
Info
Field
Type
Additional
Address
Information
Additional
Name
Information
Additional
Optional
Address
Information
Additional
Personal
Id
Number
Address
Class
Effective
Date
Class
Expiry
Date
Conditions
Date
Of
Birth
Date
Of
Expiry
Date
Of
Issue
Document
Additional
Number
Document
Optional
Additional
Number
Document
Number
Employer
Endorsements
Fathers
Name
First
Name
Full
Name
Issuing
Authority
Last
Name
Licence
Type
Localized
Name
Marital
Status
Mothers
Name
Mrz
Nationality
Personal
Id
Number
Place
Of
Birth
Profession
Race
Religion
Residential
Status
Restrictions
Sex
Vehicle
Class
Blood
Type
Sponsor
Visa
Type
Document
Subtype
Remarks
Residence
Permit
Type
Manufacturing
Year
Vehicle
Type
Dependent
Date
Of
Birth
Dependent
Sex
Dependent
Document
Number
Dependent
Full
Name
Eligibility
Category
Specific
Document
Validity
Vehicle
Owner
Image
Analysis
Detection
Status
Not
Available
Not
Detected
Detected
Image
Analysis
Lighting
Status
Not
Available
Too
Bright
Too
Dark
Normal
Image
Extraction
Type
Full
Document
Face
Signature
Input
Image
Analysis
Result
Processing
Status
Success
Detection
Failed
Image
Preprocessing
Failed
Stability
Test
Failed
Scanning
Wrong
Side
Field
Identification
Failed
Mandatory
Field
Missing
Invalid
Characters
Found
Image
Return
Failed
Barcode
Recognition
Failed
Mrz
Parsing
Failed
Document
Filtered
Unsupported
Document
Awaiting
Other
Side
Not
Scanned
Barcode
Detection
Failed
Recognition
Mode
None
Mrz
Id
Mrz
Visa
Mrz
Passport
Photo
Id
Full
Recognition
Barcode
Id
Rectangle
Result
Completeness
Scanning
Side
First
Second
Scanning
Status
Scanning
Side
In
Progress
Scanning
Barcode
In
Progress
Side
Scanned
Document
Scanned
Cancelled
Single
Side
Scanning
Result
Companion
String
Result
Companion
Vehicle
Class
Info
Companion
com.
microblink.
blinkid.
core.
result.
barcode
Barcode
Data
Companion
Barcode
Element
Barcode
Element
Key
Document
Type
Standard
Version
Number
Customer
Family
Name
Customer
First
Name
Customer
Full
Name
Date
Of
Birth
Sex
Eye
Color
Address
Street
Address
City
Address
Jurisdiction
Code
Address
Postal
Code
Full
Address
Height
Height
In
Height
Cm
Customer
Middle
Name
Hair
Color
Name
Suffix
AKAFull
Name
AKAFamily
Name
AKAGiven
Name
AKASuffix
Name
Weight
Range
Weight
Pounds
Weight
Kilograms
Customer
Id
Number
Family
Name
Truncation
First
Name
Truncation
Middle
Name
Truncation
Place
Of
Birth
Address
Street2
Race
Ethnicity
Name
Prefix
Country
Identification
Residence
Street
Address
Residence
Street
Address2
Residence
City
Residence
Jurisdiction
Code
Residence
Postal
Code
Residence
Full
Address
Under18
Under19
Under21
Social
Security
Number
AKASocial
Security
Number
AKAMiddle
Name
AKAPrefix
Name
Organ
Donor
Veteran
AKADate
Of
Birth
Issuer
Identification
Number
Document
Expiration
Date
Jurisdiction
Version
Number
Jurisdiction
Vehicle
Class
Jurisdiction
Restriction
Codes
Jurisdiction
Endorsement
Codes
Document
Issue
Date
Federal
Commercial
Vehicle
Codes
Issuing
Jurisdiction
Standard
Vehicle
Classification
Issuing
Jurisdiction
Name
Standard
Endorsement
Code
Standard
Restriction
Code
Jurisdiction
Vehicle
Classification
Description
Jurisdiction
Endorsment
Code
Description
Jurisdiction
Restriction
Code
Description
Inventory
Control
Number
Card
Revision
Date
Document
Discriminator
Limited
Duration
Document
Audit
Information
Compliance
Type
Issue
Timestamp
Permit
Expiration
Date
Permit
Identifier
Permit
Issue
Date
Number
Of
Duplicates
HAZMATExpiration
Date
Medical
Indicator
Non
Resident
Unique
Customer
Id
Data
Discriminator
Document
Expiration
Month
Document
Nonexpiring
Security
Version
Barcode
Elements
Companion
Barcode
Result
Companion
Barcode
Type
None
QRCode
Data
Matrix
UPCE
UPCA
EAN8
EAN13
Code128
Code39
ITF
Aztec
PDF417
com.
microblink.
blinkid.
core.
result.
classinfo
Country
None
Albania
Algeria
Argentina
Australia
Austria
Azerbaijan
Bahrain
Bangladesh
Belgium
Bosnia
And
Herzegovina
Brunei
Bulgaria
Cambodia
Canada
Chile
Colombia
Costa
Rica
Croatia
Cyprus
Czechia
Denmark
Dominican
Republic
Egypt
Estonia
Finland
France
Georgia
Germany
Ghana
Greece
Guatemala
Hong
Kong
Hungary
India
Indonesia
Ireland
Israel
Italy
Jordan
Kazakhstan
Kenya
Kosovo
Kuwait
Latvia
Lithuania
Malaysia
Maldives
Malta
Mauritius
Mexico
Morocco
Netherlands
New
Zealand
Nigeria
Pakistan
Panama
Paraguay
Philippines
Poland
Portugal
Puerto
Rico
Qatar
Romania
Russia
Saudi
Arabia
Serbia
Singapore
Slovakia
Slovenia
South
Africa
Spain
Sweden
Switzerland
Taiwan
Thailand
Tunisia
Turkey
Uae
Uganda
Uk
Ukraine
Usa
Vietnam
Brazil
Norway
Oman
Ecuador
El
Salvador
Sri
Lanka
Peru
Uruguay
Bahamas
Bermuda
Bolivia
China
European
Union
Haiti
Honduras
Iceland
Japan
Luxembourg
Montenegro
Nicaragua
South
Korea
Venezuela
Afghanistan
Aland
Islands
American
Samoa
Andorra
Angola
Anguilla
Antarctica
Antigua
And
Barbuda
Armenia
Aruba
Bailiwick
Of
Guernsey
Bailiwick
Of
Jersey
Barbados
Belarus
Belize
Benin
Bhutan
Bonaire
Saint
Eustatius
And
Saba
Botswana
Bouvet
Island
British
Indian
Ocean
Territory
Burkina
Faso
Burundi
Cameroon
Cape
Verde
Caribbean
Netherlands
Cayman
Islands
Central
African
Republic
Chad
Christmas
Island
Cocos
Islands
Comoros
Congo
Cook
Islands
Cuba
Curacao
Democratic
Republic
Of
The
Congo
Djibouti
Dominica
East
Timor
Equatorial
Guinea
Eritrea
Ethiopia
Falkland
Islands
Faroe
Islands
Federated
States
Of
Micronesia
Fiji
French
Guiana
French
Polynesia
French
Southern
Territories
Gabon
Gambia
Gibraltar
Greenland
Grenada
Guadeloupe
Guam
Guinea
Guinea
Bissau
Guyana
Heard
Island
And
Mc
Donald
Islands
Iran
Iraq
Isle
Of
Man
Ivory
Coast
Jamaica
Kiribati
Kyrgyzstan
Laos
Lebanon
Lesotho
Liberia
Libya
Liechtenstein
Macau
Madagascar
Malawi
Mali
Marshall
Islands
Martinique
Mauritania
Mayotte
Moldova
Monaco
Mongolia
Montserrat
Mozambique
Myanmar
Namibia
Nauru
Nepal
New
Caledonia
Niger
Niue
Norfolk
Island
Northern
Cyprus
Northern
Mariana
Islands
North
Korea
North
Macedonia
Palau
Palestine
Papua
New
Guinea
Pitcairn
Reunion
Rwanda
Saint
Barthelemy
Saint
Helena
Ascension
And
Tristian
Da
Cunha
Saint
Kitts
And
Nevis
Saint
Lucia
Saint
Martin
Saint
Pierre
And
Miquelon
Saint
Vincent
And
The
Grenadines
Samoa
San
Marino
Sao
Tome
And
Principe
Senegal
Seychelles
Sierra
Leone
Sint
Maarten
Solomon
Islands
Somalia
South
Georgia
And
The
South
Sandwich
Islands
South
Sudan
Sudan
Suriname
Svalbard
And
Jan
Mayen
Eswatini
Syria
Tajikistan
Tanzania
Togo
Tokelau
Tonga
Trinidad
And
Tobago
Turkmenistan
Turks
And
Caicos
Islands
Tuvalu
United
States
Minor
Outlying
Islands
Uzbekistan
Vanuatu
Vatican
City
Virgin
Islands
British
Virgin
Islands
Us
Wallis
And
Futuna
Western
Sahara
Yemen
Yugoslavia
Zambia
Zimbabwe
Schengen
Area
Document
Class
Info
Companion
Region
None
Alabama
Alaska
Alberta
Arizona
Arkansas
Australian
Capital
Territory
British
Columbia
California
Colorado
Connecticut
Delaware
District
Of
Columbia
Florida
Georgia
Hawaii
Idaho
Illinois
Indiana
Iowa
Kansas
Kentucky
Louisiana
Maine
Manitoba
Maryland
Massachusetts
Michigan
Minnesota
Mississippi
Missouri
Montana
Nebraska
Nevada
New
Brunswick
New
Hampshire
New
Jersey
New
Mexico
New
South
Wales
New
York
Northern
Territory
North
Carolina
North
Dakota
Nova
Scotia
Ohio
Oklahoma
Ontario
Oregon
Pennsylvania
Quebec
Queensland
Rhode
Island
Saskatchewan
South
Australia
South
Carolina
South
Dakota
Tasmania
Tennessee
Texas
Utah
Vermont
Victoria
Virginia
Washington
Western
Australia
West
Virginia
Wisconsin
Wyoming
Yukon
Ciudad
De
Mexico
Jalisco
Newfoundland
And
Labrador
Nuevo
Leon
Baja
California
Chihuahua
Guanajuato
Guerrero
Mexico
Michoacan
New
York
City
Tamaulipas
Veracruz
Chiapas
Coahuila
Durango
Guerrero
Cocula
Guerrero
Juchitan
Guerrero
Tepecoacuilco
Guerrero
Tlacoapa
Gujarat
Hidalgo
Karnataka
Kerala
Khyber
Pakhtunkhwa
Madhya
Pradesh
Maharashtra
Morelos
Nayarit
Oaxaca
Puebla
Punjab
Queretaro
San
Luis
Potosi
Sinaloa
Sonora
Tabasco
Tamil
Nadu
Yucatan
Zacatecas
Aguascalientes
Baja
California
Sur
Campeche
Colima
Quintana
Roo
Benito
Juarez
Quintana
Roo
Quintana
Roo
Solidaridad
Tlaxcala
Quintana
Roo
Cozumel
Sao
Paolo
Rio
De
Janeiro
Rio
Grande
Do
Sul
Northwest
Territories
Nunavut
Prince
Edward
Island
Distrito
Federal
Maranhao
Mato
Grosso
Minas
Gerais
Para
Parana
Pernambuco
Santa
Catarina
Andhra
Pradesh
Ceara
Goias
Guerrero
Acapulco
De
Juarez
Haryana
Sergipe
Alagoas
Bangsamoro
Type
None
Consular
Id
Dl
Dl
Public
Services
Card
Employment
Pass
Fin
Card
Id
Multipurpose
Id
My
Kad
My
Kid
My
Pr
My
Tentera
Pan
Card
Professional
Id
Public
Services
Card
Residence
Permit
Resident
Id
Temporary
Residence
Permit
Voter
Id
Work
Permit
IKad
Military
Id
My
Kas
Social
Security
Card
Health
Insurance
Card
Passport
SPass
Address
Card
Alien
Id
Alien
Passport
Green
Card
Minors
Id
Postal
Id
Professional
Dl
Tax
Id
Weapon
Permit
Visa
Border
Crossing
Card
Driver
Card
Global
Entry
Card
My
Polis
Nexus
Card
Passport
Card
Proof
Of
Age
Card
Refugee
Id
Tribal
Id
Veteran
Id
Citizenship
Certificate
My
Number
Card
Consular
Passport
Minors
Passport
Minors
Public
Services
Card
Driving
Privilege
Card
Asylum
Request
Driver
Qualification
Card
Provisional
Dl
Refugee
Passport
Special
Id
Uniformed
Services
Id
Immigrant
Visa
Consular
Voter
Id
Twic
Card
Exit
Entry
Permit
Mainland
Travel
Permit
Taiwan
Nbi
Clearance
Proof
Of
Registration
Temporary
Protection
Permit
Afghan
Citizen
Card
Eid
Pass
Sis
Id
Asic
Card
Bidoon
Card
Interim
Health
Insurance
Card
Non
Voter
Id
Reciprocal
Health
Insurance
Card
Vehicle
Registration
Esaad
Card
com.
microblink.
blinkid.
core.
result.
image
Cropped
Image
Result
Detailed
Cropped
Image
Result
Image
Base
Result
Input
Image
Result
com.
microblink.
blinkid.
core.
result.
mrz
Document
Type
Unknown
Identity
Card
Passport
Visa
Green
Card
Mys
Pass
IMM13P
Driver
License
Internal
Travel
Document
Border
Crossing
Card
Mrz
Result
Companion
com.
microblink.
blinkid.
core.
result.
viz
Viz
Result
Companion
com.
microblink.
blinkid.
core.
session
Blink
Id
Process
Result
Companion
Blink
Id
Scanning
Result
Companion
Blink
Id
Scanning
Session
Blink
Id
Session
Settings
Document
Already
Scanned
Exception
Input
Image
Source
Photo
Video
Result
Retrieved
Exception
Scanning
Mode
Single
Automatic
com.
microblink.
blinkid.
core.
settings
Anonymization
Mode
None
Image
Only
Result
Fields
Only
Full
Result
Cropped
Image
Settings
Detailed
Field
Type
Detection
Level
Off
Low
Mid
High
Document
Anonymization
Settings
Document
Filter
Document
Number
Anonymization
Settings
Document
Rules
Recognition
Mode
Filter
Scanning
Settings
com.
microblink.
core
Corrupted
Assets
Exception
Initialization
Exception
Invalid
License
Key
Exception
License
Locked
Exception
Product
Pdf417Mobi
Photo
Pay
Blink
ID
Blink
Input
Blink
Card
Document
Verification
Liveness
Microblink
Core
Invalid
Product
Remote
License
Check
Exception
Resource
Download
Exception
Resource
Load
Error
Resource
Load
Result
Ok
Missing
File
Invalid
File
Invalid
License
Sdk
Init
Error
License
Error
Memory
Reserve
Error
Resource
Load
Errors
Sdk
Initialization
Exception
com.
microblink.
core.
geometry
Point
Quadrilateral
com.
microblink.
core.
image
Image
Rotation
Companion
Rotation0
Rotation90
Rotation180
Rotation270
Input
Image
Bitmap
Camera2
Camera2Like
Camera
X
Companion
to
Degrees()
com.
microblink.
core.
license
License
State
Invalid
Requires
Server
Permission
Valid
License
Token
Issue
Remote
Lock
Payload
Corrupted
Payload
Signature
Verification
Failed
Incorrect
Token
State
License
Rights
Companion
License
Status
Server
Permission
Info
com.
microblink.
core.
network
Request
Timeout
Companion
com.
microblink.
core.
resources
Resource
Check
Result
Resource
Downloader
com.
microblink.
core.
session
Detection
Status
Failed
Success
Camera
Too
Far
Camera
Too
Close
Camera
Angle
Too
Steep
Document
Too
Close
To
Camera
Edge
Document
Partially
Visible
com.
microblink.
core.
utils
cache
Path()
default
Resource
Download
Url
default
Resources
Local
Folder
com.
microblink.
util
String
Utils
blinkid-ux
com.
microblink.
blinkid.
ux
Blink
Id
Camera
Scanning
Screen()
com.
microblink.
blinkid.
ux.
activity
Blink
Id
Scan
Activity
Blink
Id
Scan
Activity
View
Model
com.
microblink.
blinkid.
ux.
contract
Blink
Id
Scan
Activity
Colors
Blink
Id
Scan
Activity
Result
Blink
Id
Scan
Activity
Result
Status
Document
Scanned
Canceled
Error
Sdk
Init
Blink
Id
Scan
Activity
Settings
Blink
Id
Scanning
Result
Holder
Mb
Blink
Id
Scan
Cancel
Reason
User
Requested
Error
Sdk
Init
Companion
com.
microblink.
blinkid.
ux.
scanning
Blink
Id
Analyzer
Blink
Id
Document
Located
Location
Blink
Id
Scanning
Done
Handler
Blink
Id
Scanning
Ux
Translator
Blink
Id
Ux
Translator
dispatch
Blink
Id
Events()
Document
Image
Analysis
Result
com.
microblink.
blinkid.
ux.
settings
Blink
Id
Ux
Settings
Class
Filter
com.
microblink.
blinkid.
ux.
state
Blink
Id
Ui
State
com.
microblink.
blinkid.
ux.
theme
Blink
Id
Color
Scheme
Blink
Id
Sdk
Theme()
Dark
Blink
Id
Color
Scheme
microblink-ux
com.
microblink.
ux
Default
Show
Help
Button
Default
Show
Onboarding
Dialog
Scanning
Ux()
Scanning
Ux
Event
Blur
Detected
Document
Located
Document
Not
Found
Document
Not
Fully
Visible
Document
Too
Close
Document
Too
Close
To
Camera
Edge
Document
Too
Far
Document
Too
Tilted
Glare
Detected
Request
Document
Side
Scanning
Done
Scanning
Wrong
Side
Scanning
Ux
Event
Handler
Ui
Settings
com.
microblink.
ux.
camera
Camera
Lens
Facing
Lens
Facing
Back
Lens
Facing
Front
Camera
Settings
Camera
View
Model
Image
Analyzer
Resolution
Resolution720p
Resolution1080p
Resolution2160p
Resolution4320p
com.
microblink.
ux.
camera.
compose
Camera
Permission
Denied
Screen()
Camera
Screen()
com.
microblink.
ux.
components
Document
Drawable
Document
Flip
Animation()
Error
Dialog()
Exit
Button()
fill
Help
Screens()
Help
Box()
Help
Button()
Help
Screen
Page
Help
Screens
Help
Screens()
Help
Screens
Content
Landscape()
Help
Screens
Content
Portrait()
Loading
Screen()
Message
Container()
Need
Help
Tooltip()
Onboarding
Dialog()
Onboarding
Dialog
Content()
Reticle()
Reticle
Success()
Torch
Button()
com.
microblink.
ux.
state
Base
Ui
State
Cancel
Request
State
Cancel
Not
Requested
Cancel
By
User
Cancel
License
Error
Cancel
Analyzer
Settings
Unsuitable
Cancel
Unknown
Error
Card
Animation
State
Hidden
Show
Flip
Landscape
Show
Flip
Portrait
Show
Rotation
To
Portrait
Show
Rotation
To
Landscape
Document
Side
Front
Back
Barcode
Error
State
No
Error
Error
Invalid
License
Error
Network
Error
Error
Timeout
Expired
Error
Document
Class
Filtered
Haptic
Feedback
State
Vibration
Off
Vibration
One
Time
Short
Vibration
One
Time
Long
Mb
Torch
State
Not
Supported
By
Camera
Off
On
Processing
State
Sensing
Processing
Card
Animation
Success
Animation
Success
Error
Error
Dialog
Reticle
State
Hidden
Sensing
Indefinite
Progress
Success
Error
Status
Message
Empty
Scan
Front
Side
Scan
Back
Side
Scan
Barcode
Flip
Document
Rotate
Document
Rotate
Document
Short
Move
Farther
Move
Closer
Keep
Document
Visible
Align
Document
Move
Document
From
Edge
Increase
Lighting
Intensity
Decrease
Lighting
Intensity
Eliminate
Blur
Eliminate
Glare
Filter
Specific
Message
Scanning
Wrong
Side
com.
microblink.
ux.
theme
Black
Cobalt
Cobalt
Dark
Cobalt
Light
Dark
Color
Scheme
Dark
Gray
Error
Red
Gray
Help
Dialogs
Strings
Companion
Light
Color
Scheme
Local
Base
Sdk
Strings
Local
Base
Ui
Colors
Local
Theme
Local
Typography
Scanning
Strings
Companion
Sdk
Strings
Companion
Sdk
Theme
Sdk
Typography
Ui
Colors
Companion
Ui
Typography
Companion
White
com.
microblink.
ux.
utils
Error
Reason
Error
Invalid
License
Error
Network
Error
Error
Timeout
Expired
Error
Document
Class
Filtered
to
Error
State()
microblink-ux
/
com.microblink.ux
/
ScanningUxEvent
/
DocumentNotFullyVisible
Document
Not
Fully
Visible
object
DocumentNotFullyVisible
:
ScanningUxEvent