Face match
The "Face Match" API offers a robust and secure way to compare and verify identities using facial recognition technology. This API is designed to accurately match a person's face from two different images, such as a selfie or passport-size photo (first image) and an ID card containing the individual's image (second image). Utilizing advanced algorithms, it not only compares faces with high precision but also checks for the presence of masks, enhancing its utility in various verification scenarios. The API response includes a verification status, match percentage, and detailed mask detection results, ensuring a comprehensive and reliable identity verification process.
Name | Value | Required | Description |
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Parameter | Data Type | Description | Required |
firstImage | String | Individual image. Can be a passport-size photo or a selfie. | Mandatory |
secondImage | String | ID card image containing the individual's image. | Mandatory |
threshold | Float | The threshold value can be passed between 0.05 to 0.95. The default value is 0.5. If the image match percentage is greater than or equal to threshold then the result would be true otherwise false. | optional |
alignHorizontally | String | Align the image horizontally, possible values: "yes" or "no". The default value is "no". | optional |
detectMask | Array of strings | Array of image URLs to check if the person is wearing a mask. | optional |
Parameter | Data Type | Description |
result | object | The main result object containing the response. |
result.verified | boolean | Indicates whether the verification was successful (true or false). |
result.message | string | A message describing the result of the verification process. |
result.matchPercentage | string | The percentage indicating the level of match or similarity. |
result.maskDetections | array of object | An array containing mask detection information. |
result.maskDetections.maskDetected | boolean | Indicates whether a mask was detected in the provided image (true or false). |
result.maskDetections.confidence | number | A numerical value indicating the confidence level of the mask detection. |
result.maskDetections.url | string | The URL of the image that was analyzed for mask detection. |
- Max Image size supported is 5 MB
- For best results, please make sure the image you use fits tightly in the camera view and is horizontally aligned.
- Don't pass the same URL in both the input images. it will throw a 400 error if the same URL is passed in both the first and second image.
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!