New "matchrate" field

API will now include a field matchrate with every successful request, this value represents the percentage of document data fields successfully parsed by the API.

For example, a driver licence normally has 4 fields: firstname, lastname, address, and date of birth. A document submitted is too blurry, and our API could only recognize firstname, lastname and address, but not the date of birth, the matchrate would be 0.75.

This new field can be used to determine the image quality of the document, if the document is too blurry, cropped the score would be low. A healthy score would be > 0.8 to 0.9. Note that it is normal not to score a 1 for matchrate, there are some optional fields which isn't available on everyone's document.

Additional Input Format

This update aims at improving compatibility and ease of integration when it comes to uploading image to our service. Traditionally, developers are required to submit a multipart/form-data POST request to the api endpoint, which wasn't a straight-forward process for many programming framework and libraries. Today, without deprecating the aforementioned method, we are adding two extra request fields, file_base64 and face_base64, allowing developers to upload image using common key-value pairs POST type application/x-www-form-urlencoded.

To submit document or face image under the new fields, simply read and encode the entire image file in base64 format. For example in PHP:

<?php
$pathToDocumentImage = "document.jpg";
$post = [
    'file_base64' => base64_encode(file_get_contents($pathToDocumentImage)),
    'apikey' => 'YOUR API KEY'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idanalyzer.com');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
$response = curl_exec($ch);
var_export($response);
?>

It is also possible to submit the base64 data that comes from HTML img src tag, similar to:

data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE.................

We hoped that the addition of these two parameters will simplify the process connecting your application to our API.

Change of API Endpoint

We have updated the API endpoint of ID Analyzer to https://api.idanalyzer.com from https://www.idanalyzer.com/api, the new endpoint has reduced latency, improved security and performance through global CDN.

The deprecated endpoint will continue to function until 31 December 2020, all customers should have sufficient time to make the switch.

API Benchmarking

We are continuously updating our algorithms to achieve faster response time on ID Analyzer. Today, we have added a new response parameter executionTime, which output a floating number in seconds on the time taken to process your document. Customers can make use of this value to cross reference the settings and benchmark our API.

The key to fast response time is always scaling down the document image before submitting to our API. Scaling down the input image while maintaining text readability should keep the executionTime well under 1.5 seconds, and of course, it will take more time to authenticate, crop, or perform biometric verification.