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.

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://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' 
--data-raw '{
    "version": "24c8e4b80946d27f5c807994874477e81af5a529617bf91e92b29393e617cb3d",
    "input": {
        "url1": "https://images.hola.com/images/027f-177f5be615a4-df10198c7b91-1000/horizontal-1200/brad-pitt.jpg",
        "url2": "https://www.whitehouse.gov/wp-content/uploads/2021/04/P20210303AS-1901-cropped.jpg?w=1536"
    }
}'

    

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



                                                                            
GET https://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 like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). 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 paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

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.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, look at the β€˜X-Zyla-API-Calls-Monthly-Remaining’ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

The β€˜X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
359ms

Category:


Related APIs