Know Your Customer
Liveliness
Face Match
introduction face match api is used to ensure that two images belong to same person/individual in this we need to either upload two images or give urls of two images to match ,as input to the api you can also provide a optional threshold value between 0 05 0 95 to decide which match is false or true if match percentage is greater than or equal to threshold then true otherwise false it compares two images and gives the ratio of matching between them and matchpercentage between them in response, it gives three things as mentioned below verified true or false a message that says whether the verification completed with positive result or negative result a matchpercentage to signify the percentage of match between the two given images face mask detection signzy is one of the first movers in the industry to develop its proprietary face mask detection solutions which detects if a user is wearing a mask or not during a remote unassisted onboarding use case it works with our current face match solution and makes gtm faster for our current clientele the user flow for face mask detection consists of the following steps end customer provides a selfie client sends the selfie image to signzy signzy detects the mask on the face of the user by identifying facial landmarks on the face signzy provides the response to the client that the user is wearing a mask or not with confidence score given below are the features of face mask detection that are worth noting accuracy is more than 98% platform agnostic as we provide restful api faster response time i e less than 3 seconds secure data storage & purging policy jpg & png images are supported max image size supported is 7 mb how to call the api you must first login before sending the request the authorization header in the request must include the access token obtained from the login api call api input guidelines both firstimage url and secondimage url are mandatory parameters sample curl production curl location request post 'https //api signzy app/api/v3/internals/facematch/facematches' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data raw '{ "firstimage" "\<url of image 1>", "secondimage" "\<url of image 2", "detectmask" \[ "\<image 1 url>", ] }' preproduction curl location request post 'https //api preproduction signzy app/api/v3/internals/facematch/facematches' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data raw '{ "firstimage" "\<url of image 1>", "secondimage" "\<url of image 2", "detectmask" \[ "\<image 1 url", "\<image 2 url" ] }' input parameters parameter name required/optional description authorization required contains the id parameter returned from the login step content type required application/json firstimage required url of the first image to be matched secondimage required url of the second image with which first image to be compared detectmask optional in this if image urls are passed then the api checks whether the person in the image is wearing mask or not sample response json { "firstimage" "\<first image url>", "secondimage" "\<second image url>", "detectmask" \[ "\<masked image url>" ], "facematchprovider" "aws", "id" 16, "result" { "verified" false, "message" "verification completed with negative result", "matchpercentage" "0 00%" } } response parameters parameter name description firstimage url of the first image to be matched secondimage url of the second image with which first image to be compared detectmask in this if image urls are passed then the api checks whether the person in the image is wearing mask or not facematchprovider name of the vendor which provides the response id uniqued id of the identity result this holds final result parameters of the response result verified this parameter displays whether the verification done is true/false result message the message is displayed to the user regarding the status of the verification result matchpercentage this parameter displays the match percentage between the two uploaded images status codes code message 400 invalid inputs provided 400 wrong alignhorizontally inputs, please refer docs 400 only image(s) are allowed, one of the urls does not respond like an image 415 unsupported file format, check docs getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at help\@signzy com