Face Match Validator API

Face Match Validator API

This API will analyze two provided images and it will determine if the two persons that appear are indeed the same. Check if they are different people in different images.

API description

About the API:

The Face Match Validator API is a web-based API that allows developers to submit images of faces and receive a response indicating whether or not the faces depicted in the images match. This API is useful for a wide range of applications, including but not limited to:

  • Verifying the identity of a user for security purposes, such as unlocking a device or accessing a secure account
  • Detecting and preventing fraud, such as by comparing a photo on a government ID to a live photo of the person presenting the ID
  • Automating the process of tagging and organizing photos by facial recognition

To use the Face Match Validator API, developers can send a POST request to the API's endpoint with the images to be compared as the payload. The API will return a response indicating whether or not the faces in the images match, along with a confidence score for the match. The API also allows developers to specify the level of strictness for the face matching algorithm, so that they can customize the API to meet the specific needs of their application.

 

What your API receives and what your API provides (input/output)?

 

Pass two image URL to the API. You will receive the task id. Call the get job endpoint and receive the result. 

You will be receiving:

  • is_a_match: either "false" or "true". It will depend if the two faces correspond to the same person or not. 
  • match_score: 1 to 100. Where 100 is a perfect match. 

What are the most common uses cases of this API?

 

  1. Verifying the identity of a user: The API can be used to verify the identity of a user by comparing a photo on their government ID to a live photo of them taken with a webcam or smartphone camera. This can be used to prevent fraud and ensure that only authorized individuals have access to certain resources.

  2. Detecting and preventing fraud: The API can be used to detect and prevent fraud by comparing a photo of a person presenting an ID to a photo on the ID. For example, a bank could use the API to verify that the person presenting a driver's license is the same person pictured on the license.

  3. Automating the process of tagging and organizing photos: The API can be used to automate the process of tagging and organizing photos by facial recognition. For example, a social media platform could use the API to automatically tag friends in photos that are uploaded to the platform.

  4. Unlocking devices: The API can be used to unlock devices, such as smartphones or laptops, using facial recognition. This can provide an additional layer of security and ensure that only authorized users have access to the device.

  5. Accessing secure accounts: The API can be used to verify the identity of a user when accessing a secure account, such as a financial account or a corporate network. This can help to prevent unauthorized access and protect sensitive information.

 

Are there any limitations to your plans?

The only limitation is the number of API calls you can make per month that support each plan. 

API Documentation

Endpoints


This endpoint will receive two image URLs and it will deliver the task id that you later will use to retrieve the result. 



                                                                            
POST https://www.zylalabs.com/api/864/face+match+validator+api/642/create+task
                                                                            
                                                                        

Create Task - Endpoint Features
Object Description
Request Body [Required] Json
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"Example Response":"No response example available for now."}
                                                                                                                                                                                                                    
                                                                                                    

Create Task - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/864/face+match+validator+api/642/create+task' --header 'Authorization: Bearer YOUR_API_KEY' 

    

This endpoint will retrieve the result for the job you created. 



                                                                            
GET https://www.zylalabs.com/api/864/face+match+validator+api/643/retrieve+task+result
                                                                            
                                                                        

Retrieve Task Result - Endpoint Features
Object Description
prediction_id [Required]
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            [{"action":"compare","completed_at":"2023-01-03T01:57:33+05:30","created_at":"2023-01-03T01:57:29+05:30","group_id":"123","request_id":"92c2bb01-31d6-42bb-90db-023805d8c030","result":{"image_1":{"face_detected":true,"face_quality":"Good"},"image_2":{"face_detected":true,"face_quality":"Good"},"is_a_match":true,"match_score":100,"review_recommended":false},"status":"completed","task_id":"123","type":"face"}]
                                                                                                                                                                                                                    
                                                                                                    

Retrieve Task Result - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/864/face+match+validator+api/643/retrieve+task+result?prediction_id=hodsesjboxagdcmfxiszbdxscm' --header 'Authorization: Bearer YOUR_API_KEY' 

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Face Match Validator API REST API, simply include your bearer token in the Authorization header.

Headers

Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.


Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise
Starts at $10,000/Year

  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

Zyla API Hub is, in other words, an API MarketPlace. An all-in-one solution for your developing needs. You will be accessing our extended list of APIs with only your user. Also, you won't need to worry about storing API keys, only one API key for all our products is needed.

Prices are listed in USD. We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble with paying by card, just contact us at [email protected]

Sometimes depending on the bank's fraud protection settings, a bank will decline the validation charge we make when we attempt to be sure a card is valid. We recommend first contacting your bank to see if they are blocking our charges. If more help is needed, please contact [email protected] and our team will investigate further

Prices are based on a recurring monthly subscription depending on the plan selected — plus overage fees applied when a developer exceeds a plan’s quota limits. In this example, you'll see the base plan amount as well as a quota limit of API requests. Be sure to notice the overage fee because you will be charged for each additional request.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

Just go to the pricing page of that API and select the plan that you want to upgrade to. You will only be charged the full amount of that plan, but you will be enjoying the features that the plan offers right away.

Yes, absolutely. If you want to cancel your plan, simply go to your account and cancel on the Billing page. Upgrades, downgrades, and cancellations are immediate.

You can contact us through our chat channel to receive immediate assistance. We are always online from 9 am to 6 pm (GMT+1). If you reach us after that time, we will be in contact when we are back. Also you can contact us via email to [email protected]


Related APIs