Iris Recognition API Guide

Iris Verification API

Overview

Just as a fingerprint, face or palm impression stays stable across a lifetime, a person’s iris pattern persists unchanged. Comparing two irises in a 1-to-1 match checks whether they belong to the same person.

Details

Request URL

https://faceapi.mxface.ai/api/Iris/Verify

Method type

POST

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Request body

{
  "iris1": "string",
  "iris2": "string"
}

Request parameters

iris1 YesString

base64 encoded string of iris

iris2 YesString

base64 encoded string of iris

Response body

{
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "matched": 0
}

Sample response when both irises match

{
  "matched": 1
}

Sample response when both irises do not match

{
  "matched": 0
}

Response parameters

code int

Status code.

message string

Status message.

errorMessage string

A human readable description of the error.

matched int

Returns 1 when both irises belong to the same person, otherwise 0.

Errors

200

Success

400

Invalid request. Please pass valid json with all required parameters.
Not valid biometric data or invalid format.
The input is not a valid Base-64 string.

401

Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.

500

Something went wrong, please try again later.

Add Iris API

Overview

Register a captured iris image so it can later be compared and matched against the iris patterns already stored in the database.

Details

Request URL

https://faceapi.mxface.ai/api/Iris/Enroll

Method type

POST

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Request body

{
  "iris": "string",
  "externalId": "string",
  "group": "string"
}

Request parameters

iris String

base64 encoded string of iris

externalId String

Unique external ID of the iris.

group String

Unique group name. Only \ , _ [ ] ( ) - special characters and spaces are allowed. Maximum length 255.

Response body

{
  "code": 0,
  "message": "string",
  "errorMessage": "string"
}

Sample success response

{
  "code": 200,
  "message": "Success"
}

Response parameters

code int

Status code.

message string

Status message.

errorMessage string

A human readable description of the error.

Errors

200

Success

400

Invalid request. Please pass valid json with all required parameters.
Not valid biometric data or invalid format.
The input is not a valid Base-64 string.

401

Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.

500

Something went wrong, please try again later.

Search Iris API

Overview

Search for similar identities among the registered iris images in the database by uploading a single iris image.

Details

Request URL

https://faceapi.mxface.ai/api/Iris/Search

Method type

POST

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Request body

{
  "iris": "string",
  "group": "string"
}

Request parameters

iris String

base64 encoded string of iris

group String

Unique group name. Only \ , _ [ ] ( ) - special characters and spaces are allowed. Maximum length 255.

Response body

{
  "code": 0,
  "message": "string",
  "errorMessage": "string",
  "matchResult": [
    {
      "externalId": "string",
      "matchingScore": 0
    }
  ]
}

Response parameters

code int

Status code.

message string

Status message.

errorMessage string

A human readable description of the error.

matchResult array

Array of searched irises.

externalId string

Unique external ID of the iris.

matchingScore float

Matching score of the iris images. Above zero means both irises are from the same person.

Errors

200

Success

400

Invalid request. Please pass valid json with all required parameters.
Not valid biometric data or invalid format.
The input is not a valid Base-64 string.

401

Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.

500

Something went wrong, please try again later.

Delete Iris API

Overview

Remove an iris from the database using its external ID.

Details

Request URL

https://faceapi.mxface.ai/api/Iris/Delete

Method type

DELETE

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Path parameters

externalId String

Unique external Id

Response body

{
  "code": 0,
  "message": "string",
  "errorMessage": "string"
}

Sample success response

{
  "code": 200,
  "message": "Success"
}

Response parameters

code int

Status code.

message string

Status message.

errorMessage string

A human readable description of the error.

Errors

200

Success

400

Invalid request. Please pass valid json with all required parameters.
External Id not found.

401

Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.

500

Something went wrong, please try again later.

Downloads

Developer guide

Import the collection into your own client to try every endpoint before you write a line of code.

Driver

Device driver for the MIS100V2 iris scanner.

Source code

Reference implementations of the MISCAN capture client.

Iris Recognition API

Iris Verification API

Overview

Details

Request body

Request parameters

Response body

Response parameters

Errors

Add Iris API

Overview

Details

Request body

Request parameters

Response body

Response parameters

Errors

Search Iris API

Overview

Details

Request body

Request parameters

Response body

Response parameters

Errors

Delete Iris API

Overview

Details

Path parameters

Response body

Response parameters

Errors

Downloads

Developer guide

Driver

Source code

Enter the code to download