NAV Navbar
cURL Python JavaScript Java C#

Introduction

Welcome to Microblink's Cloud API. This API enables scanning of over 500 international identity documents, including driving licenses, national identity cards, passports, and others.

Cloud API is built as a RESTful API. All requests and responses, including errors, are encoded in JSON and accessed through a secure HTTPS channel.

Image formats

​ All endpoints accept jpg/jpeg, png, bmp, wbmp, gif formats. The resolution of the image should be at least 1080p (1920×1080 px). Smaller resolutions are accepted, but won't provide optimal results. Larger resolutions are also accepted, but won't improve the scanning process significantly. There is no need to downscale your images before sending them to the API.

Keep in mind that the API is optimized for images taken with mobile phone cameras. Images taken with web cameras, which usually have much lower resolutions, might not perform as well. ​

Maximum file size accepted is 10MB. ​

Image guidelines

​ You can find general image upload guidelines here. Please follow these tips to ensure best possible results. ​

Use cases

Use case Endpoint to use
Scanning both sides of supported documents or MRZ on passports, visas and other documents. /v1/recognizers/blinkid-combined
Scanning the front side of supported documents or MRZ on passports, visas and other documents. /v1/recognizers/blinkid
Scanning barcodes on supported documents. /v1/recognizers/id-barcode
Scanning the MRZ on passports. /v1/recognizers/passport
Scanning the MRZ on visa documents. /v1/recognizers/visa
Scanning the MRZ on IDs. /v1/recognizers/mrz-id
Scanning the MRZ on all documents. /v1/recognizers/mrtd

Service Geolocation

Depending on the requests' geographical location, the load balancer will forward them to different locations to optimize the performance.

Available API URLs

Available geolocation customizations

We recommend using the global interface, which will redirect your request to the nearest server group. But, if you always need to process the requests through a single location, you can use the direct API URL for the specific server group.

We offer additional customizations that need to be arranged with our sales department in advance. We can configure the endpoint to forward all requests from a specific customer to a custom location. We can also configure designated servers for a specific customer on Google Cloud (one of the locations provided by GCP). For more info, please contact our sales team.

Privacy policy

In a production environment, there's no need to worry about deleting any sent images from Microblink's servers. We discard images immediately after processing your request. In a trial environment, you can control your image uploads through your account on the Customer Dashboard.

Postman Examples

Examples can be downloaded via our Postman Collection

Authentication

To authorize, create new Cloud API apiKey on Microblink dashboard and add authorization header to all API requests. Authorization header's value is bearer token created with your personal apiKey and apiSecret:

Authorization: 'Bearer ' + Base64.encode(apiKey + ':' + apiSecret)

Microblink Cloud API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This is the documentation for Microblink's Cloud API. You can find a list of available endpoints here, as well as request and response descriptions.

General endpoints

Application version

Code samples

# You can also use wget
curl -X GET https://api.microblink.com/v1/version \
  -H 'Accept: */*'

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.microblink.com/v1/version', headers = headers)

print(r.json())


const headers = {
  'Accept':'*/*'
};

fetch('https://api.microblink.com/v1/version',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/version");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "https://api.microblink.com/v1/version";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/version

Endpoint that returns application version

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK DefaultResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Health check

Code samples

# You can also use wget
curl -X GET https://api.microblink.com/v1/hc \
  -H 'Accept: */*'

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.microblink.com/v1/hc', headers = headers)

print(r.json())


const headers = {
  'Accept':'*/*'
};

fetch('https://api.microblink.com/v1/hc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/hc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "https://api.microblink.com/v1/hc";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/hc

Endpoint returns current server time

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Recognition information endpoints

Available recognizers

Code samples

# You can also use wget
curl -X GET https://api.microblink.com/v1/info \
  -H 'Accept: */*'

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.microblink.com/v1/info', headers = headers)

print(r.json())


const headers = {
  'Accept':'*/*'
};

fetch('https://api.microblink.com/v1/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "https://api.microblink.com/v1/info";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/info

Get available recognizers and additional data

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK InfoResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Recognition endpoints

BlinkID

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/blinkid \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/blinkid', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string",
  "scanCroppedDocumentImage": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/blinkid',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/blinkid");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/blinkid";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""anonymizeImage"": true,
  ""ageLimit"": 0,
  ""imageSource"": ""string"",
  ""scanCroppedDocumentImage"": false
}";
      BlinkIdRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(BlinkIdRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(BlinkIdRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/blinkid

Scanning the front side of supported documents or MRZ on passports, visas and other documents.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string",
  "scanCroppedDocumentImage": false
}

Parameters

Name In Type Required Description
body body BlinkIdRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

BlinkID Combined

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/blinkid-combined \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/blinkid-combined', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "imageFrontSide": "string",
  "imageBackSide": "string",
  "ageLimit": 0,
  "scanCroppedDocumentImage": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/blinkid-combined',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/blinkid-combined");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/blinkid-combined";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""skipUnsupportedBack"": false,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""anonymizeImage"": true,
  ""imageFrontSide"": ""string"",
  ""imageBackSide"": ""string"",
  ""ageLimit"": 0,
  ""scanCroppedDocumentImage"": false
}";
      BlinkIDCombinedRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(BlinkIDCombinedRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(BlinkIDCombinedRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/blinkid-combined

Scanning both sides of supported documents or MRZ on passports, visas and other documents.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "imageFrontSide": "string",
  "imageBackSide": "string",
  "ageLimit": 0,
  "scanCroppedDocumentImage": false
}

Parameters

Name In Type Required Description
body body BlinkIDCombinedRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dataMatchResult": "NOT_PERFORMED",
    "dateOfExpiryPermanent": true,
    "scanningFirstSideDone": true,
    "additionalPersonalIdNumber": "string",
    "frontViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "backViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "frontImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "backImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "frontProcessingStatus": "SUCCESS",
    "backProcessingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdCombinedEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

IDBarcode

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/id-barcode \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/id-barcode', headers = headers)

print(r.json())

const inputBody = '{
  "imageSource": "string",
  "inputString": "string",
  "ageLimit": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/id-barcode',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/id-barcode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/id-barcode";

      string json = @"{
  ""imageSource"": ""string"",
  ""inputString"": ""string"",
  ""ageLimit"": 0
}";
      IdBarcodeRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(IdBarcodeRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(IdBarcodeRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/id-barcode

Scanning barcodes on supported documents.

Body parameter

{
  "imageSource": "string",
  "inputString": "string",
  "ageLimit": 0
}

Parameters

Name In Type Required Description
body body IdBarcodeRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "documentType": "NONE",
    "rawDataBase64": "string",
    "stringData": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "address": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "issuingAuthority": "string",
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "street": "string",
    "postalCode": "string",
    "city": "string",
    "jurisdiction": "string",
    "extendedElements": [
      {
        "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
        "value": "string"
      }
    ]
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK IDBarcodeEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

MRTD

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/mrtd \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/mrtd', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/mrtd',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/mrtd");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/mrtd";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""anonymizeImage"": true,
  ""ageLimit"": 0,
  ""imageSource"": ""string""
}";
      MRTDRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(MRTDRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(MRTDRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/mrtd

Scanning the MRZ on all documents.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Parameters

Name In Type Required Description
body body MRTDRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

MrzId

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/mrz-id \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/mrz-id', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/mrz-id',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/mrz-id");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/mrz-id";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""anonymizeImage"": true,
  ""ageLimit"": 0,
  ""imageSource"": ""string""
}";
      MrzIdRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(MrzIdRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(MrzIdRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/mrz-id

Scanning the MRZ on Id documents.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Parameters

Name In Type Required Description
body body MrzIdRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Passport

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/passport \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/passport', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/passport',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/passport");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/passport";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""anonymizeImage"": true,
  ""ageLimit"": 0,
  ""imageSource"": ""string""
}";
      PassportRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(PassportRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(PassportRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/passport

Scanning the MRZ on passports.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Parameters

Name In Type Required Description
body body PassportRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Visa

Code samples

# You can also use wget
curl -X POST https://api.microblink.com/v1/recognizers/visa \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.microblink.com/v1/recognizers/visa', headers = headers)

print(r.json())

const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "imageSource": "string",
  "ageLimit": 0,
  "anonymizeImage": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.microblink.com/v1/recognizers/visa',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("https://api.microblink.com/v1/recognizers/visa");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://api.microblink.com/v1/recognizers/visa";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""imageSource"": ""string"",
  ""ageLimit"": 0,
  ""anonymizeImage"": true
}";
      VisaRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(VisaRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(VisaRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/recognizers/visa

Scanning the MRZ on visa documents.

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "imageSource": "string",
  "ageLimit": 0,
  "anonymizeImage": true
}

Parameters

Name In Type Required Description
body body VisaRequest true none

Example responses

200 Response

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

400 Response

Responses

Status Meaning Description Schema
200 OK OK BlinkIdEndpointResponse
400 Bad Request Bad Request DefaultResponse
403 Forbidden Forbidden DefaultResponse
500 Internal Server Error Internal Server Error DefaultResponse
503 Service Unavailable Service Unavailable DefaultResponse
504 Gateway Time-out Gateway Timeout DefaultResponse

Schemas

DefaultResponse

{
  "code": "OK",
  "summary": "string"
}

General purpose response for API.

Properties

Name Type Required Restrictions Description
code string false none Microblink API codes
summary string false none Result description

Enumerated Values

Property Value
code OK
code UNCERTAIN
code EMPTY
code VERSION
code DEFAULT
code API_INFO
code INTERNAL_SERVER_ERROR
code SERVER_TOO_BUSY
code SERVER_CANCELED_REQUEST
code BAD_REQUEST
code AUTHORIZATION_HEADER_IS_NOT_VALID
code INSUFFICIENT_BALANCE
code NOT_ALLOWED_TO_EXECUTE_REQUESTED_RECOGNIZER
code API_ROLE_IS_NOT_FOUND
code INVALID_LICENSE_KEY
code RECOGNIZERS_IS_EMPTY
code RECOGNIZER_IS_NOT_VALID
code RECOGNIZER_IS_NOT_STRING
code RECOGNIZERS_IS_NOT_ARRAY_OF_STRINGS
code FORBIDDEN_RECOGNIZER
code RECOGNIZER_OR_RECOGNIZERS_IS_REQUIRED
code TOO_MANY_RECOGNIZERS_SENT
code IMAGE_SIZE_IS_TOO_BIG
code IMAGE_IS_NOT_VALID_BASE64_STRING
code IMAGE_IS_NOT_ABLE_TO_CONVERT_TO_RAW_PIXELS
code IMAGE_IS_NOT_VALID

AppInfo

{
  "name": "string",
  "version": "string"
}

Basic application information.

Properties

Name Type Required Restrictions Description
name string false none Application name
version string false none Application build version. Multiple build versions can support same API versions.

InfoResponse

{
  "app": {
    "name": "string",
    "version": "string"
  },
  "product": {
    "name": "string",
    "version": "string"
  },
  "recognizers": {
    "availableRecognizers": [
      "string"
    ],
    "experimentalRecognizers": [
      "string"
    ],
    "deprecatedRecognizers": [
      "string"
    ]
  }
}

Properties

Name Type Required Restrictions Description
app AppInfo false none Basic application information.
product AppInfo false none Basic application information.
recognizers RecognizersInfo false none Application support for recognizers

RecognizersInfo

{
  "availableRecognizers": [
    "string"
  ],
  "experimentalRecognizers": [
    "string"
  ],
  "deprecatedRecognizers": [
    "string"
  ]
}

Application support for recognizers

Properties

Name Type Required Restrictions Description
availableRecognizers [string] false none Currently available recognizers.
experimentalRecognizers [string] false none Experimental recognizers.
deprecatedRecognizers [string] false none Deprecated recognizers, will be removed in future versions.

BlinkIdRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string",
  "scanCroppedDocumentImage": false
}

Request body for Blink Id recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.
ageLimit integer(int32) false none Defines the age limit for age verification.
imageSource string true none Image source url or base64 encoded image.
scanCroppedDocumentImage boolean false none Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

AddressDetailedInfo

{
  "street": "string",
  "postalCode": "string",
  "city": "string",
  "jurisdiction": "string"
}

The details about the address.

Properties

Name Type Required Restrictions Description
street string false none The street address portion of the United States driver license owner.
postalCode string false none The postal code address portion of the United States driver license owner.
city string false none The city address portion of the United States driver license owner.
jurisdiction string false none The jurisdiction code address portion of the United States driver license owner.

BarcodeElement

{
  "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
  "value": "string"
}

Document specific extended elements that contain all barcode fields in their original form.

Properties

Name Type Required Restrictions Description
key string false none none
value string false none none

Enumerated Values

Property Value
key BARCODE_ELEMENT_KEY_DOCUMENT_TYPE
key STANDARD_VERSION_NUMBER
key CUSTOMER_FAMILY_NAME
key CUSTOMER_FIRST_NAME
key CUSTOMER_FULL_NAME
key DATE_OF_BIRTH
key SEX
key EYE_COLOR
key ADDRESS_STREET
key ADDRESS_CITY
key ADDRESS_JURISDICTION_CODE
key ADDRESS_POSTAL_CODE
key FULL_ADDRESS
key HEIGHT
key HEIGHT_IN
key HEIGHT_CM
key CUSTOMER_MIDDLE_NAME
key HAIR_COLOR
key NAME_SUFFIX
key AKA_FULL_NAME
key AKA_FAMILY_NAME
key AKA_GIVEN_NAME
key AKA_SUFFIX_NAME
key WEIGHT_RANGE
key WEIGHT_POUNDS
key WEIGHT_KILOGRAMS
key CUSTOMER_ID_NUMBER
key FAMILY_NAME_TRUNCATION
key FIRST_NAME_TRUNCATION
key MIDDLE_NAME_TRUNCATION
key PLACE_OF_BIRTH
key ADDRESS_STREET_2
key RACE_ETHNICITY
key NAME_PREFIX
key COUNTRY_IDENTIFICATION
key RESIDENCE_STREET_ADDRESS
key RESIDENCE_STREET_ADDRESS_2
key RESIDENCE_CITY
key RESIDENCE_JURISDICTION_CODE
key RESIDENCE_POSTAL_CODE
key RESIDENCE_FULL_ADDRESS
key UNDER_18
key UNDER_19
key UNDER_21
key SOCIAL_SECURITY_NUMBER
key AKA_SOCIAL_SECURITY_NUMBER
key AKA_MIDDLE_NAME
key AKA_PREFIX_NAME
key ORGAN_DONOR
key VETERAN
key AKA_DATE_OF_BIRTH
key ISSUER_IDENTIFICATION_NUMBER
key DOCUMENT_EXPIRATION_DATE
key JURISDICTION_VERSION_NUMBER
key JURISDICTION_VEHICLE_CLASS
key JURISDICTION_RESTRICTION_CODES
key JURISDICTION_ENDORSEMENT_CODES
key DOCUMENT_ISSUE_DATE
key FEDERAL_COMMERCIAL_VEHICLE_CODES
key ISSUING_JURISDICTION
key STANDARD_VEHICLE_CLASSIFICATION
key ISSUING_JURISDICTION_NAME
key STANDARD_ENDORSEMENT_CODE
key STANDARD_RESTRICTION_CODE
key JURISDICTION_VEHICLE_CLASSIFICATION_DESCRIPTION
key JURISDICTION_ENDORSMENT_CODE_DESCRIPTION
key JURISDICTION_RESTRICTION_CODE_DESCRIPTION
key INVENTORY_CONTROL_NUMBER
key CARD_REVISION_DATE
key DOCUMENT_DISCRIMINATOR
key LIMITED_DURATION_DOCUMENT
key AUDIT_INFORMATION
key COMPLIANCE_TYPE
key ISSUE_TIMESTAMP
key PERMIT_EXPIRATION_DATE
key PERMIT_IDENTIFIER
key PERMIT_ISSUE_DATE
key NUMBER_OF_DUPLICATES
key HAZMAT_EXPIRATION_DATE
key MEDICAL_INDICATOR
key NON_RESIDENT
key UNIQUE_CUSTOMER_ID
key DATA_DISCRIMINATOR
key DOCUMENT_EXPIRATION_MONTH
key DOCUMENT_NONEXPIRING
key SECURITY_VERSION
key COUNT

BarcodeResult

{
  "rawDataBase64": "string",
  "stringData": "string",
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "fullName": "string",
  "additionalNameInformation": "string",
  "address": "string",
  "placeOfBirth": "string",
  "nationality": "string",
  "race": "string",
  "religion": "string",
  "profession": "string",
  "maritalStatus": "string",
  "residentialStatus": "string",
  "employer": "string",
  "sex": "string",
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "documentNumber": "string",
  "personalIdNumber": "string",
  "documentAdditionalNumber": "string",
  "issuingAuthority": "string",
  "addressDetailedInfo": {
    "street": "string",
    "postalCode": "string",
    "city": "string",
    "jurisdiction": "string"
  },
  "driverLicenseDetailedInfo": {
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "conditions": "string"
  },
  "extendedElements": [
    {
      "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
      "value": "string"
    }
  ]
}

BarcodeResult contains data extracted from the barcode.

Properties

Name Type Required Restrictions Description
rawDataBase64 string false none The raw bytes contained inside barcode.
stringData string false none String representation of data inside barcode.
firstName string false none The first name of the document owner.
lastName string false none The last name of the document owner.
middleName string false none The middle name of the document owner.
fullName string false none The full name of the document owner.
additionalNameInformation string false none The additional name information of the document owner.
address string false none The address of the document owner.
placeOfBirth string false none The place of birth of the document owner.
nationality string false none The nationality of the documet owner.
race string false none The race of the document owner.
religion string false none The religion of the document owner.
profession string false none The profession of the document owner.
maritalStatus string false none The marital status of the document owner.
residentialStatus string false none The residential stauts of the document owner.
employer string false none The employer of the document owner.
sex string false none The sex of the document owner.
dateOfBirth DateResult false none Represents a date extracted from image.
dateOfIssue DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
documentNumber string false none The document number.
personalIdNumber string false none The personal identification number.
documentAdditionalNumber string false none The additional number of the document.
issuingAuthority string false none The issuing authority of the document.
addressDetailedInfo AddressDetailedInfo false none The details about the address.
driverLicenseDetailedInfo DriverLicenseDetailedInfo false none The driver license detailed info.
extendedElements [BarcodeElement] false none Document specific extended elements that contain all barcode fields in their original form.

BlinkIdEndpointResponse

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "imageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

Properties

Name Type Required Restrictions Description
executionId string false none Execution unique identifier.
finishTime string false none UTC time after recognition finished.
startTime string false none UTC time before recognition started.
result BlinkIdRecognizerResult false none Response body for Blink ID recognizer.

BlinkIdRecognizerResult

{
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "classInfo": {
    "country": "COUNTRY_NONE",
    "region": "REGION_NONE",
    "type": "TYPE_NONE",
    "countryName": "string",
    "isoAlpha3CountryCode": "string",
    "isoAlpha2CountryCode": "string",
    "isoNumericCountryCode": "string"
  },
  "type": "string",
  "isBelowAgeLimit": true,
  "age": 0,
  "recognitionStatus": "EMPTY",
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "address": "string",
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "documentNumber": "string",
  "sex": "string",
  "driverLicenseDetailedInfo": {
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "conditions": "string"
  },
  "fullDocumentImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": "string",
  "additionalAddressInformation": "string",
  "placeOfBirth": "string",
  "nationality": "string",
  "race": "string",
  "religion": "string",
  "profession": "string",
  "maritalStatus": "string",
  "residentialStatus": "string",
  "employer": "string",
  "personalIdNumber": "string",
  "documentAdditionalNumber": "string",
  "documentOptionalAdditionalNumber": "string",
  "issuingAuthority": "string",
  "mrzData": {
    "rawMrzString": "string",
    "documentCode": "string",
    "issuer": "string",
    "documentNumber": "string",
    "opt1": "string",
    "opt2": "string",
    "gender": "string",
    "nationality": "string",
    "primaryId": "string",
    "secondaryId": "string",
    "alienNumber": "string",
    "applicationReceiptNumber": "string",
    "immigrantCaseNumber": "string",
    "mrzVerified": true,
    "mrzParsed": true,
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentType": "UNKNOWN",
    "issuerName": "string",
    "nationalityName": "string"
  },
  "conditions": "string",
  "localizedName": "string",
  "dateOfExpiryPermanent": true,
  "additionalPersonalIdNumber": "string",
  "viz": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "localizedName": "string",
    "address": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "additionalPersonalIdNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "conditions": "string"
  },
  "barcode": {
    "rawDataBase64": "string",
    "stringData": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "address": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "issuingAuthority": "string",
    "addressDetailedInfo": {
      "street": "string",
      "postalCode": "string",
      "city": "string",
      "jurisdiction": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "extendedElements": [
      {
        "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
        "value": "string"
      }
    ]
  },
  "imageAnalysisResult": {
    "blurred": true,
    "documentImageColorStatus": "NOT_AVAILABLE",
    "documentImageMoireStatus": "NOT_AVAILABLE",
    "faceDetectionStatus": "NOT_AVAILABLE",
    "mrzDetectionStatus": "NOT_AVAILABLE",
    "barcodeDetectionStatus": "NOT_AVAILABLE"
  },
  "processingStatus": "SUCCESS",
  "recognitionMode": "NONE",
  "signatureImageBase64": "string"
}

Response body for Blink ID recognizer.

Properties

Name Type Required Restrictions Description
dateOfBirth DateResult false none Represents a date extracted from image.
classInfo ClassInfo false none Contains document class information.
type string false none The recognizer type used.
isBelowAgeLimit boolean false none The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.
age integer(int32) false none The calculated age of the document owner.
recognitionStatus string false none State of the result. It is always one of the values represented by ResultState enum
firstName string false none The first name of the document owner.
lastName string false none The last name of the document owner.
fullName string false none The full name of the document owner.
address string false none The address of the document owner.
dateOfIssue DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
documentNumber string false none The document number.
sex string false none The sex of the document owner.
driverLicenseDetailedInfo DriverLicenseDetailedInfo false none The driver license detailed info.
fullDocumentImageBase64 string false none The full document image.
faceImageBase64 string false none The face image.
additionalNameInformation string false none The additional name information of the document owner.
additionalAddressInformation string false none The additional address information of the document owner.
placeOfBirth string false none The place of birth of the document owner.
nationality string false none The nationality of the documet owner.
race string false none The race of the document owner.
religion string false none The religion of the document owner.
profession string false none The profession of the document owner.
maritalStatus string false none The marital status of the document owner.
residentialStatus string false none The residential stauts of the document owner.
employer string false none The employer of the document owner.
personalIdNumber string false none The personal identification number.
documentAdditionalNumber string false none The additional number of the document.
documentOptionalAdditionalNumber string false none The one more additional number of the document.
issuingAuthority string false none The issuing authority of the document.
mrzData MrzResult false none Represents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD).
conditions string false none The driver license conditions. Deprecated. Use conditions from driverLicenseDetailedInfo
localizedName string false none The localized name of the document
dateOfExpiryPermanent boolean false none Determines if date of expiry is permanent.
additionalPersonalIdNumber string false none The additional personal identification number.
viz VIZResult false none VIZResult contains data extracted from the Visual Inspection Zone.
barcode BarcodeResult false none BarcodeResult contains data extracted from the barcode.
imageAnalysisResult ImageAnalysisResult false none Various information obtained by analysing the scanned image.
processingStatus string false none Detailed information about the recognition process.
recognitionMode string false none RecognitionMode enum defines possible recognition modes by BlinkID(Combined)Recognizer.
signatureImageBase64 string false none The signature image.

Enumerated Values

Property Value
recognitionStatus EMPTY
recognitionStatus UNCERTAIN
recognitionStatus VALID
recognitionStatus STAGE_VALID
processingStatus SUCCESS
processingStatus DETECTION_FAILED
processingStatus IMAGE_PREPROCESSING_FAILED
processingStatus STABILITY_TEST_FAILED
processingStatus SCANNING_WRONG_SIDE
processingStatus FIELD_IDENTIFICATION_FAILED
processingStatus MANDATORY_FIELD_MISSING
processingStatus INVALID_CHARACTERS_FOUND
processingStatus IMAGE_RETURN_FAILED
processingStatus BARCODE_RECOGNITION_FAILED
processingStatus MRZ_PARSING_FAILED
processingStatus CLASS_FILTERED
processingStatus UNSUPPORTED_CLASS
processingStatus UNSUPPORTED_BY_LICENSE
processingStatus AWAITING_OTHER_SIDE
processingStatus NOT_SCANNED
recognitionMode NONE
recognitionMode MRZ_ID
recognitionMode MRZ_VISA
recognitionMode MRZ_PASSPORT
recognitionMode PHOTO_ID
recognitionMode FULL_RECOGNITION
recognitionMode BARCODE_ID

ClassInfo

{
  "country": "COUNTRY_NONE",
  "region": "REGION_NONE",
  "type": "TYPE_NONE",
  "countryName": "string",
  "isoAlpha3CountryCode": "string",
  "isoAlpha2CountryCode": "string",
  "isoNumericCountryCode": "string"
}

Contains document class information.

Properties

Name Type Required Restrictions Description
country string false none The document country.
region string false none The document region.
type string false none The type of the scanned document.
countryName string false none The name of the country that issued the scanned document.
isoAlpha3CountryCode string false none The 3 letter ISO code of the country that issued the scanned document.
isoAlpha2CountryCode string false none The 2 letter ISO code of the country that issued the scanned document.
isoNumericCountryCode string false none The ISO numeric code of the country that issued the scanned document.

Enumerated Values

Property Value
country COUNTRY_NONE
country COUNTRY_ALBANIA
country COUNTRY_ALGERIA
country COUNTRY_ARGENTINA
country COUNTRY_AUSTRALIA
country COUNTRY_AUSTRIA
country COUNTRY_AZERBAIJAN
country COUNTRY_BAHRAIN
country COUNTRY_BANGLADESH
country COUNTRY_BELGIUM
country COUNTRY_BOSNIA_AND_HERZEGOVINA
country COUNTRY_BRUNEI
country COUNTRY_BULGARIA
country COUNTRY_CAMBODIA
country COUNTRY_CANADA
country COUNTRY_CHILE
country COUNTRY_COLOMBIA
country COUNTRY_COSTA_RICA
country COUNTRY_CROATIA
country COUNTRY_CYPRUS
country COUNTRY_CZECHIA
country COUNTRY_DENMARK
country COUNTRY_DOMINICAN_REPUBLIC
country COUNTRY_EGYPT
country COUNTRY_ESTONIA
country COUNTRY_FINLAND
country COUNTRY_FRANCE
country COUNTRY_GEORGIA
country COUNTRY_GERMANY
country COUNTRY_GHANA
country COUNTRY_GREECE
country COUNTRY_GUATEMALA
country COUNTRY_HONG_KONG
country COUNTRY_HUNGARY
country COUNTRY_INDIA
country COUNTRY_INDONESIA
country COUNTRY_IRELAND
country COUNTRY_ISRAEL
country COUNTRY_ITALY
country COUNTRY_JORDAN
country COUNTRY_KAZAKHSTAN
country COUNTRY_KENYA
country COUNTRY_KOSOVO
country COUNTRY_KUWAIT
country COUNTRY_LATVIA
country COUNTRY_LITHUANIA
country COUNTRY_MALAYSIA
country COUNTRY_MALDIVES
country COUNTRY_MALTA
country COUNTRY_MAURITIUS
country COUNTRY_MEXICO
country COUNTRY_MOROCCO
country COUNTRY_NETHERLANDS
country COUNTRY_NEW_ZEALAND
country COUNTRY_NIGERIA
country COUNTRY_PAKISTAN
country COUNTRY_PANAMA
country COUNTRY_PARAGUAY
country COUNTRY_PHILIPPINES
country COUNTRY_POLAND
country COUNTRY_PORTUGAL
country COUNTRY_PUERTO_RICO
country COUNTRY_QATAR
country COUNTRY_ROMANIA
country COUNTRY_RUSSIA
country COUNTRY_SAUDI_ARABIA
country COUNTRY_SERBIA
country COUNTRY_SINGAPORE
country COUNTRY_SLOVAKIA
country COUNTRY_SLOVENIA
country COUNTRY_SOUTH_AFRICA
country COUNTRY_SPAIN
country COUNTRY_SWEDEN
country COUNTRY_SWITZERLAND
country COUNTRY_TAIWAN
country COUNTRY_THAILAND
country COUNTRY_TUNISIA
country COUNTRY_TURKEY
country COUNTRY_UAE
country COUNTRY_UGANDA
country COUNTRY_UK
country COUNTRY_UKRAINE
country COUNTRY_USA
country COUNTRY_VIETNAM
country COUNTRY_BRAZIL
country COUNTRY_NORWAY
country COUNTRY_OMAN
country COUNTRY_ECUADOR
country COUNTRY_EL_SALVADOR
country COUNTRY_SRI_LANKA
country COUNTRY_PERU
country COUNTRY_URUGUAY
country COUNTRY_BAHAMAS
country COUNTRY_BERMUDA
country COUNTRY_BOLIVIA
country COUNTRY_CHINA
country COUNTRY_EUROPEAN_UNION
country COUNTRY_HAITI
country COUNTRY_HONDURAS
country COUNTRY_ICELAND
country COUNTRY_JAPAN
country COUNTRY_LUXEMBOURG
country COUNTRY_MONTENEGRO
country COUNTRY_NICARAGUA
country COUNTRY_SOUTH_KOREA
country COUNTRY_VENEZUELA
country COUNTRY_AFGHANISTAN
country COUNTRY_ALAND_ISLANDS
country COUNTRY_AMERICAN_SAMOA
country COUNTRY_ANDORRA
country COUNTRY_ANGOLA
country COUNTRY_ANGUILLA
country COUNTRY_ANTARCTICA
country COUNTRY_ANTIGUA_AND_BARBUDA
country COUNTRY_ARMENIA
country COUNTRY_ARUBA
country COUNTRY_BAILIWICK_OF_GUERNSEY
country COUNTRY_BAILIWICK_OF_JERSEY
country COUNTRY_BARBADOS
country COUNTRY_BELARUS
country COUNTRY_BELIZE
country COUNTRY_BENIN
country COUNTRY_BHUTAN
country COUNTRY_BONAIRE_SAINT_EUSTATIUS_AND_SABA
country COUNTRY_BOTSWANA
country COUNTRY_BOUVET_ISLAND
country COUNTRY_BRITISH_INDIAN_OCEAN_TERRITORY
country COUNTRY_BURKINA_FASO
country COUNTRY_BURUNDI
country COUNTRY_CAMEROON
country COUNTRY_CAPE_VERDE
country COUNTRY_CARIBBEAN_NETHERLANDS
country COUNTRY_CAYMAN_ISLANDS
country COUNTRY_CENTRAL_AFRICAN_REPUBLIC
country COUNTRY_CHAD
country COUNTRY_CHRISTMAS_ISLAND
country COUNTRY_COCOS_ISLANDS
country COUNTRY_COMOROS
country COUNTRY_CONGO
country COUNTRY_COOK_ISLANDS
country COUNTRY_CUBA
country COUNTRY_CURACAO
country COUNTRY_DEMOCRATIC_REPUBLIC_OF_THE_CONGO
country COUNTRY_DJIBOUTI
country COUNTRY_DOMINICA
country COUNTRY_EAST_TIMOR
country COUNTRY_EQUATORIAL_GUINEA
country COUNTRY_ERITREA
country COUNTRY_ETHIOPIA
country COUNTRY_FALKLAND_ISLANDS
country COUNTRY_FAROE_ISLANDS
country COUNTRY_FEDERATED_STATES_OF_MICRONESIA
country COUNTRY_FIJI
country COUNTRY_FRENCH_GUIANA
country COUNTRY_FRENCH_POLYNESIA
country COUNTRY_FRENCH_SOUTHERN_TERRITORIES
country COUNTRY_GABON
country COUNTRY_GAMBIA
country COUNTRY_GIBRALTAR
country COUNTRY_GREENLAND
country COUNTRY_GRENADA
country COUNTRY_GUADELOUPE
country COUNTRY_GUAM
country COUNTRY_GUINEA
country COUNTRY_GUINEA_BISSAU
country COUNTRY_GUYANA
country COUNTRY_HEARD_ISLAND_AND_MCDONALD_ISLANDS
country COUNTRY_IRAN
country COUNTRY_IRAQ
country COUNTRY_ISLE_OF_MAN
country COUNTRY_IVORY_COAST
country COUNTRY_JAMAICA
country COUNTRY_KIRIBATI
country COUNTRY_KYRGYZSTAN
country COUNTRY_LAOS
country COUNTRY_LEBANON
country COUNTRY_LESOTHO
country COUNTRY_LIBERIA
country COUNTRY_LIBYA
country COUNTRY_LIECHTENSTEIN
country COUNTRY_MACAU
country COUNTRY_MADAGASCAR
country COUNTRY_MALAWI
country COUNTRY_MALI
country COUNTRY_MARSHALL_ISLANDS
country COUNTRY_MARTINIQUE
country COUNTRY_MAURITANIA
country COUNTRY_MAYOTTE
country COUNTRY_MOLDOVA
country COUNTRY_MONACO
country COUNTRY_MONGOLIA
country COUNTRY_MONTSERRAT
country COUNTRY_MOZAMBIQUE
country COUNTRY_MYANMAR
country COUNTRY_NAMIBIA
country COUNTRY_NAURU
country COUNTRY_NEPAL
country COUNTRY_NEW_CALEDONIA
country COUNTRY_NIGER
country COUNTRY_NIUE
country COUNTRY_NORFOLK_ISLAND
country COUNTRY_NORTHERN_CYPRUS
country COUNTRY_NORTHERN_MARIANA_ISLANDS
country COUNTRY_NORTH_KOREA
country COUNTRY_NORTH_MACEDONIA
country COUNTRY_PALAU
country COUNTRY_PALESTINE
country COUNTRY_PAPUA_NEW_GUINEA
country COUNTRY_PITCAIRN
country COUNTRY_REUNION
country COUNTRY_RWANDA
country COUNTRY_SAINT_BARTHELEMY
country COUNTRY_SAINT_HELENA_ASCENSION_AND_TRISTIAN_DA_CUNHA
country COUNTRY_SAINT_KITTS_AND_NEVIS
country COUNTRY_SAINT_LUCIA
country COUNTRY_SAINT_MARTIN
country COUNTRY_SAINT_PIERRE_AND_MIQUELON
country COUNTRY_SAINT_VINCENT_AND_THE_GRENADINES
country COUNTRY_SAMOA
country COUNTRY_SAN_MARINO
country COUNTRY_SAO_TOME_AND_PRINCIPE
country COUNTRY_SENEGAL
country COUNTRY_SEYCHELLES
country COUNTRY_SIERRA_LEONE
country COUNTRY_SINT_MAARTEN
country COUNTRY_SOLOMON_ISLANDS
country COUNTRY_SOMALIA
country COUNTRY_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS
country COUNTRY_SOUTH_SUDAN
country COUNTRY_SUDAN
country COUNTRY_SURINAME
country COUNTRY_SVALBARD_AND_JAN_MAYEN
country COUNTRY_SWAZILAND
country COUNTRY_SYRIA
country COUNTRY_TAJIKISTAN
country COUNTRY_TANZANIA
country COUNTRY_TOGO
country COUNTRY_TOKELAU
country COUNTRY_TONGA
country COUNTRY_TRINIDAD_AND_TOBAGO
country COUNTRY_TURKMENISTAN
country COUNTRY_TURKS_AND_CAICOS_ISLANDS
country COUNTRY_TUVALU
country COUNTRY_UNITED_STATES_MINOR_OUTLYING_ISLANDS
country COUNTRY_UZBEKISTAN
country COUNTRY_VANUATU
country COUNTRY_VATICAN_CITY
country COUNTRY_VIRGIN_ISLANDS_BRITISH
country COUNTRY_VIRGIN_ISLANDS_US
country COUNTRY_WALLIS_AND_FUTUNA
country COUNTRY_WESTERN_SAHARA
country COUNTRY_YEMEN
country COUNTRY_YUGOSLAVIA
country COUNTRY_ZAMBIA
country COUNTRY_ZIMBABWE
region REGION_NONE
region REGION_ALABAMA
region REGION_ALASKA
region REGION_ALBERTA
region REGION_ARIZONA
region REGION_ARKANSAS
region REGION_AUSTRALIAN_CAPITAL_TERRITORY
region REGION_BRITISH_COLUMBIA
region REGION_CALIFORNIA
region REGION_COLORADO
region REGION_CONNECTICUT
region REGION_DELAWARE
region REGION_DISTRICT_OF_COLUMBIA
region REGION_FLORIDA
region REGION_GEORGIA
region REGION_HAWAII
region REGION_IDAHO
region REGION_ILLINOIS
region REGION_INDIANA
region REGION_IOWA
region REGION_KANSAS
region REGION_KENTUCKY
region REGION_LOUISIANA
region REGION_MAINE
region REGION_MANITOBA
region REGION_MARYLAND
region REGION_MASSACHUSETTS
region REGION_MICHIGAN
region REGION_MINNESOTA
region REGION_MISSISSIPPI
region REGION_MISSOURI
region REGION_MONTANA
region REGION_NEBRASKA
region REGION_NEVADA
region REGION_NEW_BRUNSWICK
region REGION_NEW_HAMPSHIRE
region REGION_NEW_JERSEY
region REGION_NEW_MEXICO
region REGION_NEW_SOUTH_WALES
region REGION_NEW_YORK
region REGION_NORTHERN_TERRITORY
region REGION_NORTH_CAROLINA
region REGION_NORTH_DAKOTA
region REGION_NOVA_SCOTIA
region REGION_OHIO
region REGION_OKLAHOMA
region REGION_ONTARIO
region REGION_OREGON
region REGION_PENNSYLVANIA
region REGION_QUEBEC
region REGION_QUEENSLAND
region REGION_RHODE_ISLAND
region REGION_SASKATCHEWAN
region REGION_SOUTH_AUSTRALIA
region REGION_SOUTH_CAROLINA
region REGION_SOUTH_DAKOTA
region REGION_TASMANIA
region REGION_TENNESSEE
region REGION_TEXAS
region REGION_UTAH
region REGION_VERMONT
region REGION_VICTORIA
region REGION_VIRGINIA
region REGION_WASHINGTON
region REGION_WESTERN_AUSTRALIA
region REGION_WEST_VIRGINIA
region REGION_WISCONSIN
region REGION_WYOMING
region REGION_YUKON
region REGION_CIUDAD_DE_MEXICO
region REGION_JALISCO
region REGION_NEWFOUNDLAND_AND_LABRADOR
region REGION_NUEVO_LEON
region REGION_BAJA_CALIFORNIA
region REGION_CHIHUAHUA
region REGION_GUANAJUATO
region REGION_GUERRERO
region REGION_MEXICO
region REGION_MICHOACAN
region REGION_NEW_YORK_CITY
region REGION_TAMAULIPAS
region REGION_VERACRUZ
region REGION_CHIAPAS
region REGION_COAHUILA
region REGION_DURANGO
region REGION_GUERRERO_COCULA
region REGION_GUERRERO_JUCHITAN
region REGION_GUERRERO_TEPECOACUILCO
region REGION_GUERRERO_TLACOAPA
region REGION_GUJARAT
region REGION_HIDALGO
region REGION_KARNATAKA
region REGION_KERALA
region REGION_KHYBER_PAKHTUNKHWA
region REGION_MADHYA_PRADESH
region REGION_MAHARASHTRA
region REGION_MORELOS
region REGION_NAYARIT
region REGION_OAXACA
region REGION_PUEBLA
region REGION_PUNJAB
region REGION_QUERETARO
region REGION_SAN_LUIS_POTOSI
region REGION_SINALOA
region REGION_SONORA
region REGION_TABASCO
region REGION_TAMIL_NADU
region REGION_YUCATAN
region REGION_ZACATECAS
type TYPE_NONE
type TYPE_CONSULAR_ID
type TYPE_DL
type TYPE_DL_PUBLIC_SERVICES_CARD
type TYPE_EMPLOYMENT_PASS
type TYPE_FIN_CARD
type TYPE_ID
type TYPE_MULTIPURPOSE_ID
type TYPE_MyKad
type TYPE_MyKid
type TYPE_MyPR
type TYPE_MyTentera
type TYPE_PAN_CARD
type TYPE_PROFESSIONAL_ID
type TYPE_PUBLIC_SERVICES_CARD
type TYPE_RESIDENCE_PERMIT
type TYPE_RESIDENT_ID
type TYPE_TEMPORARY_RESIDENCE_PERMIT
type TYPE_VOTER_ID
type TYPE_WORK_PERMIT
type TYPE_iKAD
type TYPE_MILITARY_ID
type TYPE_MyKAS
type TYPE_SOCIAL_SECURITY_CARD
type TYPE_HEALTH_INSURANCE_CARD
type TYPE_PASSPORT
type TYPE_S_PASS
type TYPE_ADDRESS_CARD
type TYPE_ALIEN_ID
type TYPE_ALIEN_PASSPORT
type TYPE_GREEN_CARD
type TYPE_MINORS_ID
type TYPE_POSTAL_ID
type TYPE_PROFESSIONAL_DL
type TYPE_TAX_ID
type TYPE_WEAPON_PERMIT
type TYPE_VISA
type TYPE_BORDER_CROSSING_CARD
type TYPE_DRIVER_CARD
type TYPE_GLOBAL_ENTRY_CARD
type TYPE_MyPolis
type TYPE_NEXUS_CARD
type TYPE_PASSPORT_CARD
type TYPE_PROOF_OF_AGE_CARD
type TYPE_REFUGEE_ID
type TYPE_TRIBAL_ID
type TYPE_VETERAN_ID

DateResult

{
  "day": 0,
  "month": 0,
  "year": 0,
  "successfullyParsed": true,
  "originalString": "string"
}

Represents a date extracted from image.

Properties

Name Type Required Restrictions Description
day integer(int32) false none Day in month
month integer(int32) false none Month in year
year integer(int32) false none Year
successfullyParsed boolean false none True if date was successfully parsed
originalString string false none String used in date parsing

DriverLicenseDetailedInfo

{
  "restrictions": "string",
  "endorsements": "string",
  "vehicleClass": "string",
  "conditions": "string"
}

The driver license detailed info.

Properties

Name Type Required Restrictions Description
restrictions string false none The restrictions to driving privileges for the United States driver license owner.
endorsements string false none The additional privileges granted to the United States driver license owner.
vehicleClass string false none The type of vehicle the driver license owner has privilege to drive.
conditions string false none The driver license conditions.

ImageAnalysisResult

{
  "blurred": true,
  "documentImageColorStatus": "NOT_AVAILABLE",
  "documentImageMoireStatus": "NOT_AVAILABLE",
  "faceDetectionStatus": "NOT_AVAILABLE",
  "mrzDetectionStatus": "NOT_AVAILABLE",
  "barcodeDetectionStatus": "NOT_AVAILABLE"
}

Various information obtained by analysing the scanned image.

Properties

Name Type Required Restrictions Description
blurred boolean false none Whether the image is blurred.
documentImageColorStatus string false none The color status determined from scanned image.
documentImageMoireStatus string false none The Moire pattern detection status determined from the scanned image.
faceDetectionStatus string false none Face detection status determined from the scanned image.
mrzDetectionStatus string false none Mrz detection status determined from the scanned image.
barcodeDetectionStatus string false none Barcode detection status determined from the scanned image.

Enumerated Values

Property Value
documentImageColorStatus NOT_AVAILABLE
documentImageColorStatus BLACK_AND_WHITE
documentImageColorStatus COLOR
documentImageMoireStatus NOT_AVAILABLE
documentImageMoireStatus NOT_DETECTED
documentImageMoireStatus DETECTED
faceDetectionStatus NOT_AVAILABLE
faceDetectionStatus NOT_DETECTED
faceDetectionStatus DETECTED
mrzDetectionStatus NOT_AVAILABLE
mrzDetectionStatus NOT_DETECTED
mrzDetectionStatus DETECTED
barcodeDetectionStatus NOT_AVAILABLE
barcodeDetectionStatus NOT_DETECTED
barcodeDetectionStatus DETECTED

MrzResult

{
  "rawMrzString": "string",
  "documentCode": "string",
  "issuer": "string",
  "documentNumber": "string",
  "opt1": "string",
  "opt2": "string",
  "gender": "string",
  "nationality": "string",
  "primaryId": "string",
  "secondaryId": "string",
  "alienNumber": "string",
  "applicationReceiptNumber": "string",
  "immigrantCaseNumber": "string",
  "mrzVerified": true,
  "mrzParsed": true,
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "documentType": "UNKNOWN",
  "issuerName": "string",
  "nationalityName": "string"
}

Represents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD).

Properties

Name Type Required Restrictions Description
rawMrzString string false none The entire Machine Readable Zone text from ID. This string is usually used for parsing other elements.
NOTE: This string is available only if OCR result was parsed successfully.
documentCode string false none The document code. Document code contains two characters. For MRTD the first character shall be A, C or I. The second character shall be discretion of the issuing State or organization except that V shall not be used, and C shall not be used after A except in the crew member certificate. On machine-readable passports (MRP) first character shall be P to designate an MRP. One additional letter may be used, at the discretion of the issuing State or organization, to designate a particular MRP. If the second character position is not used for this purpose, it shall be filled by the filter character <.
issuer string false none Three-letter or two-letter code which indicate the issuing State. Three-letter codes are based on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.
documentNumber string false none The document number. Document number contains up to 9 characters. Element does not exist on US Green Card. To see which document was scanned use documentType property.
opt1 string false none The first optional data. Contains empty string if not available. Element does not exist on US Green Card. To see which document was scanned use the documentType property.
opt2 string false none The second optional data. Contains empty string if not available. Element does not exist on Passports and Visas. To see which document was scanned use the documentType property.
gender string false none The gender of the card holder. Gender is specified by use of the single initial, capital letter F for female, M for male or < for unspecified.
nationality string false none The nationality of the holder represented by a three-letter or two-letter code. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.
primaryId string false none The primary indentifier. If there is more than one component, they are separated with space.
secondaryId string false none The secondary identifier. If there is more than one component, they are separated with space.
alienNumber string false none The alien number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use the documentType property.
applicationReceiptNumber string false none The application receipt number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use the documentType property.
immigrantCaseNumber string false none The immigrant case number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use the documentType property.
mrzVerified boolean false none True if all check digits inside MRZ are correct, false otherwise.
mrzParsed boolean false none True if Machine Readable Zone has been parsed, false otherwise.
dateOfBirth DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
documentType string false none Type of recognized document. It is always one of the values represented by MrtdDocumentType.
issuerName string false none Returns full issuer name that is expanded from the three-letter or two-letter code which indicate the issuing State.
nationalityName string false none Returns full nationality of the holder, which is expanded from the three-letter or two-letter nationality code.

Enumerated Values

Property Value
documentType UNKNOWN
documentType IDENTITY_CARD
documentType PASSPORT
documentType VISA
documentType GREEN_CARD
documentType MALAYSIAN_PASS_IMM13P
documentType DRIVER_LICENSE
documentType INTERNATIONAL_TRAVEL_DOCUMENT

VIZResult

{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "additionalNameInformation": "string",
  "localizedName": "string",
  "address": "string",
  "additionalAddressInformation": "string",
  "placeOfBirth": "string",
  "nationality": "string",
  "race": "string",
  "religion": "string",
  "profession": "string",
  "maritalStatus": "string",
  "residentialStatus": "string",
  "employer": "string",
  "sex": "string",
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiryPermanent": true,
  "documentNumber": "string",
  "personalIdNumber": "string",
  "documentAdditionalNumber": "string",
  "additionalPersonalIdNumber": "string",
  "documentOptionalAdditionalNumber": "string",
  "issuingAuthority": "string",
  "driverLicenseDetailedInfo": {
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "conditions": "string"
  },
  "conditions": "string"
}

VIZResult contains data extracted from the Visual Inspection Zone.

Properties

Name Type Required Restrictions Description
firstName string false none The first name of the document owner.
lastName string false none The last name of the document owner.
fullName string false none The full name of the document owner.
additionalNameInformation string false none The additional name information of the document owner.
localizedName string false none The localized name of the document.
address string false none The address of the document owner.
additionalAddressInformation string false none The additional address information of the document owner.
placeOfBirth string false none The place of birth of the document owner.
nationality string false none The nationality of the documet owner.
race string false none The race of the document owner.
religion string false none The religion of the document owner.
profession string false none The profession of the document owner.
maritalStatus string false none The marital status of the document owner.
residentialStatus string false none The residential stauts of the document owner.
employer string false none The employer of the document owner.
sex string false none The sex of the document owner.
dateOfBirth DateResult false none Represents a date extracted from image.
dateOfIssue DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
dateOfExpiryPermanent boolean false none Determines if date of expiry is permanent.
documentNumber string false none The document number.
personalIdNumber string false none The personal identification number.
documentAdditionalNumber string false none The additional number of the document.
additionalPersonalIdNumber string false none The additional personal identification number.
documentOptionalAdditionalNumber string false none The one more additional number of the document.
issuingAuthority string false none The issuing authority of the document.
driverLicenseDetailedInfo DriverLicenseDetailedInfo false none The driver license detailed info.
conditions string false none The driver license conditions. Deprecated. Use conditions from driverLicenseDetailedInfo

BlinkIDCombinedRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "imageFrontSide": "string",
  "imageBackSide": "string",
  "ageLimit": 0,
  "scanCroppedDocumentImage": false
}

Request body for Blink Id Combined recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
skipUnsupportedBack boolean false none Skip back side capture and processing step when back side of the document is not supported. Default FALSE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.
imageFrontSide string true none Front side of the url or base64 encoded image.
imageBackSide string false none Back side of the url or base64 encoded image..
ageLimit integer(int32) false none Defines the age limit for age verification.
scanCroppedDocumentImage boolean false none Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

BlinkIdCombinedEndpointResponse

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "address": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "sex": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "mrzData": {
      "rawMrzString": "string",
      "documentCode": "string",
      "issuer": "string",
      "documentNumber": "string",
      "opt1": "string",
      "opt2": "string",
      "gender": "string",
      "nationality": "string",
      "primaryId": "string",
      "secondaryId": "string",
      "alienNumber": "string",
      "applicationReceiptNumber": "string",
      "immigrantCaseNumber": "string",
      "mrzVerified": true,
      "mrzParsed": true,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "conditions": "string",
    "localizedName": "string",
    "dataMatchResult": "NOT_PERFORMED",
    "dateOfExpiryPermanent": true,
    "scanningFirstSideDone": true,
    "additionalPersonalIdNumber": "string",
    "frontViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "backViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "additionalPersonalIdNumber": "string",
      "documentOptionalAdditionalNumber": "string",
      "issuingAuthority": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "conditions": "string"
    },
    "barcode": {
      "rawDataBase64": "string",
      "stringData": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "address": "string",
      "placeOfBirth": "string",
      "nationality": "string",
      "race": "string",
      "religion": "string",
      "profession": "string",
      "maritalStatus": "string",
      "residentialStatus": "string",
      "employer": "string",
      "sex": "string",
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "documentNumber": "string",
      "personalIdNumber": "string",
      "documentAdditionalNumber": "string",
      "issuingAuthority": "string",
      "addressDetailedInfo": {
        "street": "string",
        "postalCode": "string",
        "city": "string",
        "jurisdiction": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string"
      },
      "extendedElements": [
        {
          "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
          "value": "string"
        }
      ]
    },
    "frontImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "backImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE"
    },
    "processingStatus": "SUCCESS",
    "frontProcessingStatus": "SUCCESS",
    "backProcessingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string"
  }
}

Properties

Name Type Required Restrictions Description
executionId string false none Execution unique identifier.
finishTime string false none UTC time after recognition finished.
startTime string false none UTC time before recognition started.
result BlinkIdCombinedRecognizerResult false none Result of BlinkIdCombinedRecognizer.

BlinkIdCombinedRecognizerResult

{
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "classInfo": {
    "country": "COUNTRY_NONE",
    "region": "REGION_NONE",
    "type": "TYPE_NONE",
    "countryName": "string",
    "isoAlpha3CountryCode": "string",
    "isoAlpha2CountryCode": "string",
    "isoNumericCountryCode": "string"
  },
  "type": "string",
  "isBelowAgeLimit": true,
  "age": 0,
  "recognitionStatus": "EMPTY",
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "address": "string",
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "documentNumber": "string",
  "sex": "string",
  "driverLicenseDetailedInfo": {
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "conditions": "string"
  },
  "fullDocumentFrontImageBase64": "string",
  "fullDocumentBackImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": "string",
  "additionalAddressInformation": "string",
  "placeOfBirth": "string",
  "nationality": "string",
  "race": "string",
  "religion": "string",
  "profession": "string",
  "maritalStatus": "string",
  "residentialStatus": "string",
  "employer": "string",
  "personalIdNumber": "string",
  "documentAdditionalNumber": "string",
  "documentOptionalAdditionalNumber": "string",
  "issuingAuthority": "string",
  "mrzData": {
    "rawMrzString": "string",
    "documentCode": "string",
    "issuer": "string",
    "documentNumber": "string",
    "opt1": "string",
    "opt2": "string",
    "gender": "string",
    "nationality": "string",
    "primaryId": "string",
    "secondaryId": "string",
    "alienNumber": "string",
    "applicationReceiptNumber": "string",
    "immigrantCaseNumber": "string",
    "mrzVerified": true,
    "mrzParsed": true,
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentType": "UNKNOWN",
    "issuerName": "string",
    "nationalityName": "string"
  },
  "conditions": "string",
  "localizedName": "string",
  "dataMatchResult": "NOT_PERFORMED",
  "dateOfExpiryPermanent": true,
  "scanningFirstSideDone": true,
  "additionalPersonalIdNumber": "string",
  "frontViz": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "localizedName": "string",
    "address": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "additionalPersonalIdNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "conditions": "string"
  },
  "backViz": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "localizedName": "string",
    "address": "string",
    "additionalAddressInformation": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "additionalPersonalIdNumber": "string",
    "documentOptionalAdditionalNumber": "string",
    "issuingAuthority": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "conditions": "string"
  },
  "barcode": {
    "rawDataBase64": "string",
    "stringData": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "address": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "issuingAuthority": "string",
    "addressDetailedInfo": {
      "street": "string",
      "postalCode": "string",
      "city": "string",
      "jurisdiction": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string"
    },
    "extendedElements": [
      {
        "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
        "value": "string"
      }
    ]
  },
  "frontImageAnalysisResult": {
    "blurred": true,
    "documentImageColorStatus": "NOT_AVAILABLE",
    "documentImageMoireStatus": "NOT_AVAILABLE",
    "faceDetectionStatus": "NOT_AVAILABLE",
    "mrzDetectionStatus": "NOT_AVAILABLE",
    "barcodeDetectionStatus": "NOT_AVAILABLE"
  },
  "backImageAnalysisResult": {
    "blurred": true,
    "documentImageColorStatus": "NOT_AVAILABLE",
    "documentImageMoireStatus": "NOT_AVAILABLE",
    "faceDetectionStatus": "NOT_AVAILABLE",
    "mrzDetectionStatus": "NOT_AVAILABLE",
    "barcodeDetectionStatus": "NOT_AVAILABLE"
  },
  "processingStatus": "SUCCESS",
  "frontProcessingStatus": "SUCCESS",
  "backProcessingStatus": "SUCCESS",
  "recognitionMode": "NONE",
  "signatureImageBase64": "string"
}

Result of BlinkIdCombinedRecognizer.

Properties

Name Type Required Restrictions Description
dateOfBirth DateResult false none Represents a date extracted from image.
classInfo ClassInfo false none Contains document class information.
type string false none The recognizer type used.
isBelowAgeLimit boolean false none The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.
age integer(int32) false none The calculated age of the document owner.
recognitionStatus string false none State of the result. It is always one of the values represented by ResultState enum
firstName string false none The first name of the document owner.
lastName string false none The last name of the document owner.
fullName string false none The last name of the document owner.
address string false none The address of the document owner.
dateOfIssue DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
documentNumber string false none The document number.
sex string false none The sex of the document owner.
driverLicenseDetailedInfo DriverLicenseDetailedInfo false none The driver license detailed info.
fullDocumentFrontImageBase64 string false none The full document front image.
fullDocumentBackImageBase64 string false none The full document front image.
faceImageBase64 string false none The face image.
additionalNameInformation string false none The additional name information of the document owner.
additionalAddressInformation string false none The additional address information of the document owner.
placeOfBirth string false none The place of birth of the document owner.
nationality string false none The nationality of the documet owner.
race string false none The race of the document owner.
religion string false none The religion of the document owner.
profession string false none The profession of the document owner.
maritalStatus string false none The marital status of the document owner.
residentialStatus string false none The residential stauts of the document owner.
employer string false none The employer of the document owner.
personalIdNumber string false none The personal identification number.
documentAdditionalNumber string false none The additional number of the document.
documentOptionalAdditionalNumber string false none The one more additional number of the document.
issuingAuthority string false none The issuing authority of the document.
mrzData MrzResult false none Represents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD).
conditions string false none The driver license conditions. Deprecated. Use conditions from driverLicenseDetailedInfo
localizedName string false none The localized name of the document.
dataMatchResult string false none We currently check document number, date of expiry, date of birth and date of issue fields.
dateOfExpiryPermanent boolean false none Determines if date of expiry is permanent.
scanningFirstSideDone boolean false none Defines whether recognizer has finished scanning first side.
additionalPersonalIdNumber string false none The additional personal identification number.
frontViz VIZResult false none VIZResult contains data extracted from the Visual Inspection Zone.
backViz VIZResult false none VIZResult contains data extracted from the Visual Inspection Zone.
barcode BarcodeResult false none BarcodeResult contains data extracted from the barcode.
frontImageAnalysisResult ImageAnalysisResult false none Various information obtained by analysing the scanned image.
backImageAnalysisResult ImageAnalysisResult false none Various information obtained by analysing the scanned image.
processingStatus string false none Detailed information about the recognition process.
frontProcessingStatus string false none Detailed information about the recognition process.
backProcessingStatus string false none Detailed information about the recognition process.
recognitionMode string false none RecognitionMode enum defines possible recognition modes by BlinkID(Combined)Recognizer.
signatureImageBase64 string false none The signature image.

Enumerated Values

Property Value
recognitionStatus EMPTY
recognitionStatus UNCERTAIN
recognitionStatus VALID
recognitionStatus STAGE_VALID
dataMatchResult NOT_PERFORMED
dataMatchResult FAILED
dataMatchResult SUCCESS
processingStatus SUCCESS
processingStatus DETECTION_FAILED
processingStatus IMAGE_PREPROCESSING_FAILED
processingStatus STABILITY_TEST_FAILED
processingStatus SCANNING_WRONG_SIDE
processingStatus FIELD_IDENTIFICATION_FAILED
processingStatus MANDATORY_FIELD_MISSING
processingStatus INVALID_CHARACTERS_FOUND
processingStatus IMAGE_RETURN_FAILED
processingStatus BARCODE_RECOGNITION_FAILED
processingStatus MRZ_PARSING_FAILED
processingStatus CLASS_FILTERED
processingStatus UNSUPPORTED_CLASS
processingStatus UNSUPPORTED_BY_LICENSE
processingStatus AWAITING_OTHER_SIDE
processingStatus NOT_SCANNED
frontProcessingStatus SUCCESS
frontProcessingStatus DETECTION_FAILED
frontProcessingStatus IMAGE_PREPROCESSING_FAILED
frontProcessingStatus STABILITY_TEST_FAILED
frontProcessingStatus SCANNING_WRONG_SIDE
frontProcessingStatus FIELD_IDENTIFICATION_FAILED
frontProcessingStatus MANDATORY_FIELD_MISSING
frontProcessingStatus INVALID_CHARACTERS_FOUND
frontProcessingStatus IMAGE_RETURN_FAILED
frontProcessingStatus BARCODE_RECOGNITION_FAILED
frontProcessingStatus MRZ_PARSING_FAILED
frontProcessingStatus CLASS_FILTERED
frontProcessingStatus UNSUPPORTED_CLASS
frontProcessingStatus UNSUPPORTED_BY_LICENSE
frontProcessingStatus AWAITING_OTHER_SIDE
frontProcessingStatus NOT_SCANNED
backProcessingStatus SUCCESS
backProcessingStatus DETECTION_FAILED
backProcessingStatus IMAGE_PREPROCESSING_FAILED
backProcessingStatus STABILITY_TEST_FAILED
backProcessingStatus SCANNING_WRONG_SIDE
backProcessingStatus FIELD_IDENTIFICATION_FAILED
backProcessingStatus MANDATORY_FIELD_MISSING
backProcessingStatus INVALID_CHARACTERS_FOUND
backProcessingStatus IMAGE_RETURN_FAILED
backProcessingStatus BARCODE_RECOGNITION_FAILED
backProcessingStatus MRZ_PARSING_FAILED
backProcessingStatus CLASS_FILTERED
backProcessingStatus UNSUPPORTED_CLASS
backProcessingStatus UNSUPPORTED_BY_LICENSE
backProcessingStatus AWAITING_OTHER_SIDE
backProcessingStatus NOT_SCANNED
recognitionMode NONE
recognitionMode MRZ_ID
recognitionMode MRZ_VISA
recognitionMode MRZ_PASSPORT
recognitionMode PHOTO_ID
recognitionMode FULL_RECOGNITION
recognitionMode BARCODE_ID

IdBarcodeRequest

{
  "imageSource": "string",
  "inputString": "string",
  "ageLimit": 0
}

Request body for Id Barcode recognition.

Properties

Name Type Required Restrictions Description
imageSource string false none Image source url or base64 encoded image.
inputString string false none Barcode string.
ageLimit integer(int32) false none Defines the age limit for age verification.

IDBarcodeEndpointResponse

{
  "executionId": "string",
  "finishTime": "string",
  "startTime": "string",
  "result": {
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "type": "string",
    "isBelowAgeLimit": true,
    "age": 0,
    "recognitionStatus": "EMPTY",
    "documentType": "NONE",
    "rawDataBase64": "string",
    "stringData": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "address": "string",
    "placeOfBirth": "string",
    "nationality": "string",
    "race": "string",
    "religion": "string",
    "profession": "string",
    "maritalStatus": "string",
    "residentialStatus": "string",
    "employer": "string",
    "sex": "string",
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "documentNumber": "string",
    "personalIdNumber": "string",
    "documentAdditionalNumber": "string",
    "issuingAuthority": "string",
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "street": "string",
    "postalCode": "string",
    "city": "string",
    "jurisdiction": "string",
    "extendedElements": [
      {
        "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
        "value": "string"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
executionId string false none Execution unique identifier.
finishTime string false none UTC time after recognition finished.
startTime string false none UTC time before recognition started.
result IDBarcodeRecognizerResult false none Result of BlinkIdCombinedRecognizer.

IDBarcodeRecognizerResult

{
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "classInfo": {
    "country": "COUNTRY_NONE",
    "region": "REGION_NONE",
    "type": "TYPE_NONE",
    "countryName": "string",
    "isoAlpha3CountryCode": "string",
    "isoAlpha2CountryCode": "string",
    "isoNumericCountryCode": "string"
  },
  "type": "string",
  "isBelowAgeLimit": true,
  "age": 0,
  "recognitionStatus": "EMPTY",
  "documentType": "NONE",
  "rawDataBase64": "string",
  "stringData": "string",
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "fullName": "string",
  "additionalNameInformation": "string",
  "address": "string",
  "placeOfBirth": "string",
  "nationality": "string",
  "race": "string",
  "religion": "string",
  "profession": "string",
  "maritalStatus": "string",
  "residentialStatus": "string",
  "employer": "string",
  "sex": "string",
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "documentNumber": "string",
  "personalIdNumber": "string",
  "documentAdditionalNumber": "string",
  "issuingAuthority": "string",
  "restrictions": "string",
  "endorsements": "string",
  "vehicleClass": "string",
  "street": "string",
  "postalCode": "string",
  "city": "string",
  "jurisdiction": "string",
  "extendedElements": [
    {
      "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
      "value": "string"
    }
  ]
}

Result of BlinkIdCombinedRecognizer.

Properties

Name Type Required Restrictions Description
dateOfBirth DateResult false none Represents a date extracted from image.
classInfo ClassInfo false none Contains document class information.
type string false none The recognizer type used.
isBelowAgeLimit boolean false none The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.
age integer(int32) false none The calculated age of the document owner.
recognitionStatus string false none State of the result. It is always one of the values represented by ResultState enum
documentType string false none The document type deduced from the recognized barcode.
rawDataBase64 string false none The raw bytes contained inside barcode.
stringData string false none String representation of data inside barcode.
firstName string false none The first name of the document owner.
lastName string false none The last name of the document owner.
middleName string false none The middle name of the document owner.
fullName string false none The full name of the document owner.
additionalNameInformation string false none The additional name information of the document owner.
address string false none The address of the document owner.
placeOfBirth string false none The place of birth of the document owner.
nationality string false none The nationality of the document owner.
race string false none The race of the document owner.
religion string false none The religion of the document owner.
profession string false none The profession of the document owner.
maritalStatus string false none The marital status of the document owner.
residentialStatus string false none The residential status of the document owner.
employer string false none The employer of the document owner.
sex string false none The sex of the document owner.
dateOfIssue DateResult false none Represents a date extracted from image.
dateOfExpiry DateResult false none Represents a date extracted from image.
documentNumber string false none The document number.
personalIdNumber string false none The personal identification number.
documentAdditionalNumber string false none The additional number of the document.
issuingAuthority string false none The issuing authority of the document.
restrictions string false none The restrictions to driving privileges for the driver license owner.
endorsements string false none The additional privileges granted to the driver license owner.
vehicleClass string false none The type of vehicle the driver license owner has privilege to drive.
street string false none The street address portion of the document owner.
postalCode string false none The postal code address portion of the document owner.
city string false none The city address portion of the document owner.
jurisdiction string false none The jurisdiction code address portion of the document owner.
extendedElements [BarcodeElement] false none Document specific extended elements that contain all barcode fields in their original form.

Enumerated Values

Property Value
recognitionStatus EMPTY
recognitionStatus UNCERTAIN
recognitionStatus VALID
recognitionStatus STAGE_VALID
documentType NONE
documentType AAMVA_COMPLIANT
documentType ARGENTINA_ID
documentType ARGENTINA_DL
documentType COLOMBIA_ID
documentType COLOMBIA_DL
documentType NIGERIA_VOTER_ID
documentType NIGERIA_DL
documentType PANAMA_ID
documentType SOUTH_AFRICA_ID

MRTDRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Request body for MRTD request recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.
ageLimit integer(int32) false none Defines the age limit for age verification.
imageSource string true none Image source url or base64 encoded image.

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

MrzIdRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Request body for MrzId request recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.
ageLimit integer(int32) false none Defines the age limit for age verification.
imageSource string true none Image source url or base64 encoded image.

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

PassportRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "anonymizeImage": true,
  "ageLimit": 0,
  "imageSource": "string"
}

Request body for Passport recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.
ageLimit integer(int32) false none Defines the age limit for age verification.
imageSource string true none Image source url or base64 encoded image.

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

VisaRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "imageSource": "string",
  "ageLimit": 0,
  "anonymizeImage": true
}

Request body for Visa recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode string false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT
imageSource string true none Image source url or base64 encoded image.
ageLimit integer(int32) false none Defines the age limit for age verification.
anonymizeImage boolean false none Deprecated. Defines whether sensitive data should be anonymized in full document image result.

Enumerated Values

Property Value
anonymizationMode NONE
anonymizationMode IMAGE_ONLY
anonymizationMode RESULT_FIELDS_ONLY
anonymizationMode FULL_RESULT

Release Notes

1.35.1

Bug fixes:

1.35.0

New documents added to BlinkID(Combined)Recognizer:

Improvements for existing features

Bug fixes:

1.34.0

Newly supported identity documents:

For a full list of the supported documents please see here.

Changes to the BlinkId(Combined)Recognizer:

Changes to the IdBarcodeRecognizer:

Deprecated recognizers:

1.33.2

Improvements for existing features:

We upgraded image to use microblink/java:16 as base image for its security improvements

1.33.0

New additions to our supported documents list

For a full list of the supported documents please see here.

New features and updates to the BlinkId(Combined)Recognizer

Fixes

1.32.1

Improvements to existing features:

We changed the default value for allowBlurFilter parameter to false. Now blurred documents won't be discarded by default. If you wish to prevent extracting data from such documents, set this value to true in your request

1.32.0

New additions to our supported documents list

Plastic page passports

We added support for scanning the visual inspection zone - VIZ includes everything except MRZ or barcode. Keep in mind that BlinkID scans and extracts data only from the VIZ that is on the first plastic page found in the passport list below:

European DLs with a single line MRZ

BlinkID extracts data from driver’s licenses that contain single line MRZ:

Back side supported on:

No longer BETA

New features and updates in BlinkID(Combined)Recognizer

Deprecated recognizer New recognizer
DOC_FACE BLINK_ID with photoId right
MRTD BLINK_ID with mrz_id, mrz_visa, mrz_passport rights
PASSPORT BLINK_ID with mrz_passport right
VISA BLINK_ID with mrz_visa right
AUT_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
BEL_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
BEL_ID_BACK BLINK_ID_COMBINED
BRN_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
BRN_ID_BACK BLINK_ID_COMBINED
COL_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
CYP_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
CYP_ID_BACK BLINK_ID_COMBINED
CYP_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
HKG_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
INDONESIA_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
IRL_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
ITA_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
KWT_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
KWT_ID_BACK BLINK_ID_COMBINED
MYS_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
IKAD_FRONT BLINK_ID or BLINK_ID_COMBINED
MYKAD_FRONT BLINK_ID or BLINK_ID_COMBINED
MYKAD_BACK BLINK_ID_COMBINED
MYPR_FRONT BLINK_ID or BLINK_ID_COMBINED
MYTENTERA_FRONT BLINK_ID or BLINK_ID_COMBINED
MEX_VOTER_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
NZL_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
NIGERIA_VOTER_ID_BACK BLINK_ID_COMBINED
SGP_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
SGP_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
SGP_ID_BACK BLINK_ID_COMBINED
ESP_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
UAE_DL_FRONT BLINK_ID or BLINK_ID_COMBINED
UAE_ID_FRONT BLINK_ID or BLINK_ID_COMBINED
UAE_ID_BACK BLINK_ID_COMBINED

For a full list of the supported documents please see here.

Other features and updates

Fixes