Face Match (Image & Transaction ID)

---

Instead of sending two images, you can provide one face image and the Transaction ID of a valid Data Extraction service transaction, so we can compare the face from this transaction's document with the face image provided. The transaction ID can be found in the data extraction API response.

You can use the Face Match service by providing two face images to be compared. The result will be "True" if similar or "False" if not.

Face Match (Image & Transaction ID)

POST https://valifystage.com/api/v1.1/face/match/

Headers

Name	Type	Description
Content-Type	string	application/json
Authentication	string	Bearer <access-token>

Request Body

Name	Type	Description
first_img	string	A base64-encoded face image.
transaction_id	string	An ID of a successful Data Extraction transaction
bundle_key	string	A bundle key provided to you by Valify.
lang	string	The preferred language for the error messages.

200 Successful

{
    'result': {
        'is_similar': '<bool>', 
         'confidence': '<float>'
     }, 
     'transaction_id': '<str>', 
     'trials_remaining': '<int>'
 }

400 Missing input data

{
    "message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}

401 Invalid bundle key

{
    "message": "Unauthorized – your Bundle key is invalid"
}

403 Access token error

{
    "message": "Forbidden – specified access_token could not be found"
}

404 Check the endpoint

{
    "message": "Not Found"
}

415 The format should be base64

{
    "message": "Unsupported Media Type"
}

422 Check Valify error codes

{
    "message": "<error-description>",
    "error_code": <valify-error-code>
}

500 Contact us

{
    "message": "Internal Server Error"
}

Integration

Postman

1. Download the JSON file.

975B

Documentation - Face Match (image & transaction ID) (v1).postman_collection

Face Match (2 images)

1. Open Postman and click on Import.

1. Drop the JSON file.

1. Click on "Face Match" then click on "Authorization" and replace the <access token> field with your access token and then click on "Body".

1. Click on "Face Match" then "Body" and fill in the required fields then click on "Send".

Please note that the front and back images should be converted to base 64 format. This can be done via an online tool; https://base64.guru/converter/encode/image/jpg

Python

import requests
import base64

def base64_encode(file_name):
    with open(file_name, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read()).decode()
        return encoded_string
    return ""

face_img = base64_encode('<image path>')
token = '<token>'
data = {
        'first_img': face_img,
        'transaction_id': '<transaction id>', # Place the transaction ID here
        'bundle_key': '<bundle key>', # Place your bundle key here
        'lang': 'en'
}

r = requests.post("https://valifystage.com/api/v1/face/match/",
        json=data,
        headers={'Authorization': 'Bearer %s' % token}
    )
                      
print(r.json())