Fingerprint Recognition API Guide
Fingerprint Verification
DownloadChoose a platform
View on GitHub
Overview
Fingerprints are like personal signatures, each one distinct and unique to an individual. These impressions, formed by the patterns on our fingers, play a crucial role in confirming identity. When we compare two fingerprints in a 1-to-1 match, we're checking if they belong to the same person. It's a straightforward but highly reliable way to confirm someone's identity.
Details
Request URL:- https://fingerprintapi.mxface.ai/api/FingerPrint/Verify
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"fingerPrint1": "string",
"fingerPrint2": "string"
}
Request Parameters
| Param | Required | Type | Description |
|---|---|---|---|
| fingerPrint1 | Yes | String | base64 encoded string of fingerprint |
| fingerPrint1 | Yes | String | base64 encoded string of fingerprint. |
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
Fingerprints, distinguished by their unique patterns, are a singular and inherent feature for each individual. Fingerprint authentication, in a 1-to-N (one-to-many) comparison, entails capturing a user's fingerprint and cross-referencing it with a database to establish the user's claimed identity. The intricate ridges and grooves on human fingers form these distinctive impressions, creating a robust and reliable method for personalized identification.
Details
Request URL:- https://fingerprintapi.mxface.ai/api/FingerPrint/Enroll
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"fingerPrint": "string",
"externalId": "string",
"group": "string"
}
Request Parameters
| Fields | Type | Description |
|---|---|---|
| fingerPrint | String | base64 encoded string of fingerprint |
| 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"
}
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 Fingerprints in the database by uploading a Fingerprint (image). This API accepts only one Fingerprint.
Details
Request URL:- https://fingerprintapi.mxface.ai/api/FingerPrint/Search
Method Type:-POST
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Request Body
{
"fingerPrint": "string",
"group": "string"
}
Request Parameters
| Fields | Type | Description |
|---|---|---|
| fingerPrint | String | base64 encoded string of fingerPrint |
| group | String | Unique group name. Only \\, _,[,],(,),- special characters and space is allowed in group name. Maximum length of 255. The search will be limited to fingerprints belonging to these group. If this is empty, fingerprint will be searched across all groups. |
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 Fingerprints. |
| externalId | string | Unqiue External ID of Fingerprints. |
| matchingScore | float | Matching Score of the Fingerprint Images.If greater than zero, both fingerprints 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 Fingerprints from the database by ExternalId.
Details
Request URL:- https://fingerprintapi.mxface.ai/api/FingerPrint/Delete
Method Type:-DELETE
Headers:-
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxxx
Path Parameters
| Fields | Type | Description |
|---|---|---|
| externalId | String | Unique external Id of Fingerprint |
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
