Verify document photo

This endpoint allows the matching between the user selfie and the photo on the ID document simultaneously.

The IDCard photo sent in this request is provided at the response of the method Validate Document, so is necessary to store the photo temporarily to send it along with the uploaded photo sample taken at the moment.

Document - Verify document photo

POST https://api.biometrid.com/api/1.1/document/selfie-compare

Headers

Name	Type	Description
Content-type	string	Request content type (This is not required to be set. Referenced only to show how we expect data to be sent). { "Content-Type": "multipart/form-data" }
x-biometrid-key	string	Application Client Key
x-biometrid-secret	string	Application Client Secret

Request Body

Name	Type	Description
facemap	string	Required only for specific liveness engine version. Paired with photo. Ask for further details.
photo	string	Required only for specific liveness engine version. Paired with facemap. Ask for further details.
photo1	object	Image file containing photo for biometric analysis. File format: jpeg, png or jpg. Max size: 1 MB.
photo2	object	Image file containing photo for biometric analysis. File format: jpeg, png or jpg. Max size: 1 MB.
livenessId	string	Liveness session identifier obtained from successful validation. Required if liveness is active for in Client configuration.

200 Success 200 types

HTTP/1.1 200 OK

//Selfie Commpare Process
{
    "status": true,
    "data": {
        "message": "FACE_COMPARED_WITH_SUCCESS",
        "verified": true,
        "confidence": "0.99"
        }
    }
}

//Selfie Commpare Process (special engine case)
{
    "status": true,
    "data": {
        "message": "FACE_COMPARED_WITH_SUCCESS",
        "verified": true,
        }
    }
}

//Selfie Compare Process Failed
{
    "status": false,
    "data": {
        "message": "FACE_COMPARISON_FAILED"
        }
    }
}

400 Bad Request types

HTTP/1.1 400 Bad Request

//No photo files detected on request. Not sent or invalid format.
{
    "status": false,
    "data": {
        "message": "NO_FILES_OR_INVALID_FORMATS"
    }
}
//Missing photo files on request.
{
    "status": false,
    "data": {
        "message": "EXPECTING_2_IMAGE_FILES_TO_COMPARE"
    }
}
//Missing Headers.
{
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Client not found by given key.

HTTP/1.1 404 Not Found

{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}

405 No active engine configuration for this provider.

HTTP/1.1 405 Method Not Allowed

{
    "status": false,
    "data": {
        "message": "NO_FACE_ENGINE_CONFIGURATION_AVAILABLE"
    }
}

428 Precondition Required

HTTP/1.1 428 Precondition Required

{
    "status": false,
    "data": {
        "message": "NO_LIVENESS_DETECTION"
    }
}

POST https://api.biometrid.com/api/1.1/document/selfie-compare

Request Body

Name	Type	Description
photo	string

200

Example (JSON)

{
    "photo1": photo1.jpeg,
    "photo2": photo2.jpeg,
    "livenessId": "d3213-23dds2-75rgu6-ds3434"
}

Success 200

Field	Type	Description
status	Boolean	Response status.
data	Object	Response main data.
message	String	Message regarding the selfie compare process.
verified	Boolean	Photos comparison result.
confidence	String	Photos comparison result confidence.