Iris Recognition API Guide
Iris Verification
DownloadChoose a platform
View on GitHub
Overview
Just as the fingerprint, face and palm impression of an individual remains stable during their lifetime, a person's iris pattern also persists to be exactly similar throughout his life. When we compare Iris in a 1-to-1 match, we're checking if they belong to the same person. Iris recognition technology proves to be secure, reliable and error-free verification process amongst all biometric verification methods.
Details
Request URL:- https://iris.mxface.ai/api/Iris/Verify
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"iris1": "string",
"iris2": "string"
}
Request Parameters
| Param | Required | Type | Description |
|---|---|---|---|
| iris1 | Yes | String | base64 encoded string of iris |
| iris2 | Yes | String | base64 encoded string of iris |
Response Body
{
"code": 0,
"message": "string",
"errorMessage": "string",
"matched": 0
}
Sample response when both fingerprints match
{
"matched": 1
}
Sample response when both fingerprints not match
{
"matched": 0
}
Response Parameters
| Param | Type | Description |
|---|---|---|
| code | int | Code |
| message | string | Message |
| errorMessage | string | A human readable description of error |
| matched | int | If both iris matched, result will be 1 otherwise 0 |
Errors
| Error Code | Message |
|---|---|
| 200 | Success |
| 401 | Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription. |
| 400 | Invalid request. Please pass valid json with all required parameters. A human readable description of error |
| 500 | Something went wrong, please try again later. |
Overview
The captured Iris images of either one or both of human irises with higher resolution to compare and match it with the existing iris pattern of an individual saved in the database.
Details
Request URL:- https://iris.mxface.ai/api/Iris/Enroll
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"iris": "string",
"externalId": "string",
"group": "string"
}
Request Parameters
| Fields | Type | Description |
|---|---|---|
| iris | String | base64 encoded string of iris |
| externalId | String | Unqiue External ID of fingerprint. |
| group | String | Unique group name. Only \\, _,[,],(,),- special characters and space is allowed in group name. Maximum length of 255. |
Response Body
{
"code": 0,
"message": "string",
"errorMessage": "string"
}
Sample success response
{
"code": 200,
"message": "Success"
}
Sample response when both fingerprints not match
{
"matched": 0
}
Response Parameters
| Field | Type | Description |
|---|---|---|
| code | int | Code |
| message | string | Message |
| errorMessage | string | A human readable description of error |
Errors
| Error Code | Message |
|---|---|
| 200 | Success |
| 401 | Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription. |
| 400 | Invalid request. Please pass valid json with all required parameters. Not valid biometric data or invalid format. Duplicate Biometric. Duplicate External Id. The input is not a valid Base-64 string. |
| 500 | Something went wrong, please try again later. |
Overview
Search similar looking Identities from registered Iris images in the database by uploading an Iris (image).
Details
Request URL:- https://iris.mxface.ai/api/Iris/Search
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"iris": "string",
"group": "string"
}
Request Parameters
| Fields | Type | Description |
|---|---|---|
| iris | String | base64 encoded string of iris |
| group | String | Unique group name. Only \\, _,[,],(,),- special characters and space is allowed in group name. Maximum length of 255. |
Response Body
{
"code": 0,
"message": "string",
"errorMessage": "string",
"matchResult": [
{
"externalId": "string",
"matchingScore": 0
}
]
}
Response Parameters
| Field | Type | Description |
|---|---|---|
| code | int | Code |
| message | string | Message |
| errorMessage | string | A human readable description of error |
| matchResult | array | Array of Searched Iris. |
| externalId | string | Unqiue External ID of Iris. |
| matchingScore | float | Matching Score of the Iris Images.If greater than zero, both iriss are from the same person. |
Error
| Error Code | Message |
|---|---|
| 200 | Success |
| 401 | Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription. |
| 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. |
| 500 | Something went wrong, please try again later. |
Overview
Remove Iris from the database by ExternalId.
Details
Request URL:- https://iris.mxface.ai/api/Iris/Delete
Method Type:-DELETE
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Path Parameters
| Fields | Type | Description |
|---|---|---|
| externalId | String | Unique external Id |
Response Body
{
"code": 0,
"message": "string",
"errorMessage": "string"
}
Sample success response
{
"code": 200,
"message": "Success"
}
Response Parameters
| Field | Type | Description |
|---|---|---|
| code | int | Code |
| message | string | Message |
| errorMessage | string | A human readable description of error |
Error
| Error Code | Message |
|---|---|
| 200 | Success |
| 401 | Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription. |
| 400 | Invalid request. Please pass valid json with all required parameters. External Id not found. |
| 500 | Something went wrong, please try again later. |
Choose a platform
