Perform Face Matching

Match the face on an ID document to the face on a selfie

Perform Face Matching

POST https://api.appruve.co/v1/face_match_jobs

This endpoint allows you to match the face on an ID document to the face on a selfie. This is particularly useful if you just want to match the faces and get the percentage match. This is also useful if you have previously used the Perform Standalone OCR endpoint and would want to match the face on the ID card on which the OCR was performed to the face on a selfie.

Headers

Name	Type	Description
Authorization*	string	Bearer <token>

Request Body

Name	Type	Description
ocr_job_reference	string	The transaction reference value returned from the Perform Standalone OCR endpoint. Pass this value if you want to match the face on the ID card on which the OCR was performed to the face on a selfie.
selfie_image*	object	The Selfie photo file object
id_card_image*	object	The ID card photo file object. Required if no value is passed for ocr_job_reference.

200 Success

{
    "id_card_face_url": "URL of detected face on the ID card image",
    "selfie_face_url": "URL of detected face on the Selfie image",
    "percentage_match": 0.0
}

Example Request (without ocr_job_reference):

curl --location --request POST 'https://api.appruve.co/v1/face_match_jobs' \
--header 'Authorization: Bearer <token>' \
--form 'id_card_image=@"/path/to/id_card_image.jpg"' \
--form 'selfie_image=@"/path/to/selfie_image.jpg"'

Example request (with ocr_job_reference)

curl --location --request POST 'https://api.appruve.co/v1/face_match_jobs' \
--header 'Authorization: Bearer <token>' \
--form 'selfie_image=@"/path/to/selfie_image.jpg"' \
--form 'ocr_job_reference="e6f3cac2-f218-477b-81be-c1e732e4c6bc"'