Lightning Iris Authentication REST API


The Lightning Iris Authentication Server offers easy to use RESTful API for Unique Biometrics Iris Authentication Algorithms for integration in to end-user Applications/Solutions. It provides fast and extremely scalable Iris Authentication (true 1:N identification and 1:1 verification) relying on proven accuracy and resilience of the Iris Biometrics. The Lightning Iris Authentication Server provides API to:
  • Generate Iris Signature from an iris image
  • Enroll/Register a Subject with reference iris images
  • Identify a Subject by iris image(s)
  • Verify a registered Subject by iris image(s)
  • Un-register/Un-enroll a Subject
  • Get Server license status
  • See examples below for complete list of API
You can easily test these API using Google Chrome extension (picture below) Postman REST Client. We have example json test data collection for testing the REST API for you. The server requires oAuth2 access token, please email us at mailto:license@uniquebiometrics.com to request authorization token if you would like to evaluate the server. These REST API are easily integrated in to Applications and Solutions based on Java, .NET, PHP, Python etc., for providing Iris Authentication capabilities.

We have setup an instance of the Lightning Iris Authentication Server on Microsoft Azure Cloud and accessible via our domain https://www.iris-cloud.com. This page gives you working code snippets in Javascript/jQuery and compatible with latest Web Browsers (Chrome, IE11, Edge, Safari) supporting HTML5. You an run these sample code snippets against live Lighting Iris Authentication Server hosted on https://iris-cloud.com:8181/uniqbio/irisserver/. These samples can be easily modified to run under any environment (.NET, Java, PHP, Python, Node.js etc.) of your liking. This shows how easy it is to integrate Iris Authentication capabilities to virtually any kind of Applications including purely browser based, iOS/Android, Windows 10 Universal Apps and others. Please ask questions in this forum related to Lightning Iris Authentication Server and questions regarding API and programming environment. We will make our very best effort to provide best possible support with a smile :)

Checking the status of the Server

Following Javascript/jQuery can be used to retrieve status from the Lightning Iris Authentication Server.
NOTE - This API does not require oAuth2 "Access Token".


			
				 
				

The API response shown below:


Obtaining the oAuth2 Authorization Token

Making calls to Lighthning Iris Authentication Server requires a vaild oAuth2 "Access Token". Following JavaScript can be used to obtain an oAuth2 "Access Token" from Lightning Iris Authentication Server. "Access Token" is valid until the expiration time or if the Server is restarted. You may reuse the token until API encounters "Not Authorized" - HTTP error 401/403.



				 
				

The generated Access Token displayed below will be used by subsequent API calls


Generating an Iris Signature (Encode)

Following JavaScript can be used to generate Iris Signature from an eye image. Images taken from Iris Scanners conforming to ISO/IEC 19794-6 Iris Image Standards are recommanded for optimal accuracy. The image of the eye containing the iris should meet following requirements in general:

  • Image should be 8bit grayscale jpeg, bmp or raw pixel data. To reduce the payload size, we recommnd jpeg compression with quality set to 80
  • Image size should be less than 720x520 pixels, cropped around the eye, with eye is in the center of the frame
  • Diameter of the eye should be between 160 to 280 pixels
  • Images should have good contrast between pupil/iris and iris/scalara boundary
  • Free of excessive specular reflections on the iris
  • Reflections from IR illumination should be inside the pupil bounds

		
				 
				
				

The processed iris image extracted from the API response will be displayed below:

An oAuth2 Access Token is required to make the call.


Identify an unknown Subject with Iris Signature

Following JavaScript can be used to perform an iris identification (1:N).


			
				 
				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Verify a Known Subject using Iris Signature (1:1)

Following JavaScript can be used to perform an iris verification (1:1).


			
				 
				
				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Compare 2 Iris Signatures

Following JavaScript can be used to compare 2 Iris Signatures.


			
				 
				
				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Enroll a Subject

Following JavaScript can be used to enroll a new Subject.


			
				 

				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Check for an existing Subject by Id

Following JavaScript can be used to check for existance of a given Subject in the enrollment data store.


			
				 

				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Retrieve Enrollement Data

Following JavaScript can be used to get an existing Subject from the enrollment data store.


			
				 

				

The API response shown below:

An oAuth2 Access Token is required to make the call.


Delete a Subject

Following JavaScript can be used to delete an existing Subject from the enrollment data store.


			
				 

				

The API response shown below:

An oAuth2 Access Token is required to make the call.