API Reference
Verify one fingerprint against another, or search a captured print against a registered gallery. Minutiae-based matching for slap, rolled and single-finger captures.
Fingerprints work like personal signatures — each one distinct and unique to an individual. Comparing two fingerprints in a 1-to-1 match checks whether they belong to the same person.
1-to-1
Two prints compared
Minutiae
Ridge pattern matching
Binary result
Matched or not matched
Request URL
https://faceapi.mxface.ai/api/FingerPrint/Verify
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
{
"fingerPrint1": "string",
"fingerPrint2": "string"
}fingerPrint1
YesString
base64 encoded string of fingerprint
fingerPrint2
YesString
base64 encoded string of fingerprint
{
"code": 0,
"message": "string",
"errorMessage": "string",
"matched": 0
}Sample response when both fingerprints match
{
"matched": 1
}Sample response when both fingerprints do not match
{
"matched": 0
}code
int
Status code.
message
string
Status message.
errorMessage
string
A human readable description of the error.
matched
int
Returns 1 when both fingerprints match, otherwise 0.
200Success
400Invalid request. Please pass valid json with all required parameters.
A human readable description of error
401Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.
500Something went wrong, please try again later.
In a 1-to-N comparison a captured fingerprint is cross-referenced against a database to establish the claimed identity. The ridges and grooves on human fingers form these distinctive impressions.
Request URL
https://faceapi.mxface.ai/api/FingerPrint/Enroll
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
{
"fingerPrint": "string",
"externalId": "string",
"group": "string"
}fingerPrint
String
base64 encoded string of fingerprint
externalId
String
Unique external ID of the fingerprint.
group
String
Unique group name. Only \ , _ [ ] ( ) - special characters and spaces are allowed. Maximum length 255.
{
"code": 0,
"message": "string",
"errorMessage": "string"
}Sample success response
{
"code": 200,
"message": "Success"
}code
int
Status code.
message
string
Status message.
errorMessage
string
A human readable description of the error.
200Success
400Invalid 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.
401Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.
500Something went wrong, please try again later.
Search for similar identities among the registered fingerprints in the database by uploading a fingerprint image. This API accepts one fingerprint per request.
Request URL
https://faceapi.mxface.ai/api/FingerPrint/Search
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
{
"fingerPrint": "string",
"group": "string"
}fingerPrint
String
base64 encoded string of fingerprint
group
String
Unique group name. Only \ , _ [ ] ( ) - special characters and spaces are allowed. Maximum length 255. The search is limited to fingerprints belonging to this group. If it is empty the fingerprint is searched across all groups.
{
"code": 0,
"message": "string",
"errorMessage": "string",
"matchResult": [
{
"externalId": "string",
"matchingScore": 0
}
]
}code
int
Status code.
message
string
Status message.
errorMessage
string
A human readable description of the error.
matchResult
array
Array of searched fingerprints.
externalId
string
Unique external ID of the fingerprint.
matchingScore
float
Matching score of the fingerprint images. Above zero means both fingerprints are from the same person.
200Success
400Invalid 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.
401Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.
500Something went wrong, please try again later.
Remove fingerprints from the database using the external ID.
Request URL
https://faceapi.mxface.ai/api/FingerPrint/Delete
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
externalId
String
Unique external Id of the fingerprint
{
"code": 0,
"message": "string",
"errorMessage": "string"
}Sample success response
{
"code": 200,
"message": "Success"
}code
int
Status code.
message
string
Status message.
errorMessage
string
A human readable description of the error.
200Success
400Invalid request. Please pass valid json with all required parameters.
External Id not found.
401Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.
500Something went wrong, please try again later.
Import the collection into your own client to try every endpoint before you write a line of code.
Device driver for the MFSCAN fingerprint scanner.
Reference implementations of the MFSCAN capture client.
Try it on your own images
Free trial key unlocks every model.
Verify to continue
Captcha does not match. Please try again.