NAV
cURL Python JavaScript Java C#

Introduction

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

Here you can find instructions how to setup docker image locally and how to execute recognitions over API. This specification is related to versions 2.0.0 and higher. For previous versions please visit out dockerhub page and check postman colletion.

Use cases

Use case Endpoint to use
Scanning both sides of supported documents or MRZ on passports, visas and other documents. /blinkid-combined
Scanning the front side of supported documents or MRZ on passports, visas and other documents. /blinkid
Scanning barcodes on supported documents. /id-barcode
Scanning of bank cards. /blinkcard
Scanning of barcodes. /barcode

Image formats

​ All endpoints accept jpg/jpeg and png 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. ​

Image guidelines

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

Third party software

Self-hosted API is built as native image with GraalVM Community Edition. License can be found here.

Open source tools

Open source tools are used for the current version and may differ for a previous versions.

Name Version License
ch.qos.logback:logback-core http://www.qos.ch 1.2.9 GNU Lesser General Public License
com.fasterxml.jackson.core:jackson-core https://github.com/FasterXML/jackson-core 2.12.4 The Apache Software License, Version 2.0
io.micrometer:micrometer-core https://github.com/micrometer-metrics/micrometer 1.8.0 The Apache Software License, Version 2.0
io.micrometer:micrometer-registry-prometheus https://github.com/micrometer-metrics/micrometer 1.8.0 The Apache Software License, Version 2.0
io.micronaut.aws:micronaut-aws-bom null 3.0.4 null
io.micronaut.configuration:micronaut-micrometer-core http://micronaut.io 1.3.1 The Apache Software License, Version 2.0
io.micronaut.configuration:micronaut-micrometer-registry-prometheus http://micronaut.io 1.3.1 The Apache Software License, Version 2.0
io.micronaut.kotlin:micronaut-kotlin-runtime http://micronaut.io 3.0.0 The Apache Software License, Version 2.0
io.micronaut.reactor:micronaut-reactor https://micronaut.io 2.1.1 The Apache Software License, Version 2.0
io.micronaut.security:micronaut-security https://micronaut.io 3.2.2 The Apache Software License, Version 2.0
io.micronaut.security:micronaut-security-annotations https://micronaut.io 3.2.2 The Apache Software License, Version 2.0
io.micronaut.sql:micronaut-sql-bom null 4.0.4 null
io.micronaut.views:micronaut-views-bom null 3.0.4 null
io.micronaut:micronaut-core http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-http http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-http-client-core http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-jackson-core http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-json-core http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-management http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-runtime http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.micronaut:micronaut-validation http://micronaut.io 3.2.5 The Apache Software License, Version 2.0
io.projectreactor:reactor-core https://github.com/reactor/reactor-core 3.4.11 Apache License, Version 2.0
io.projectreactor:reactor-core https://github.com/reactor/reactor-core 3.4.8 Apache License, Version 2.0
jakarta.annotation:jakarta.annotation-api https://www.eclipse.org 2.0.0 GPL2 w/ CPE
jakarta.inject:jakarta.inject-api https://www.eclipse.org 2.0.1 The Apache Software License, Version 2.0
javax.annotation:javax.annotation-api https://javaee.github.io/glassfish 1.3.2 COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
org.jetbrains.kotlinx:kotlinx-coroutines-core null 1.5.1 null
org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm https://github.com/Kotlin/kotlinx.coroutines 1.5.1 The Apache Software License, Version 2.0
org.mapstruct:mapstruct http://mapstruct.org/mapstruct/ 1.4.2.Final The Apache Software License, Version 2.0
org.slf4j:slf4j-api http://www.slf4j.org 1.7.32 MIT License
org.yaml:snakeyaml http://www.snakeyaml.org 1.29 Apache License, Version 2.0

OpenAPI 3

OpenAPI 3 specification can be downloaded here, you can use it to generete your client code for integration with Self-hosted API.

Ping statistics

Ping statistics is used to report scan success rate. It is regulated with your license agreement, and as such enabled or disabled in Self-hosted API.

Postman

Examples can be downloaded via our Postman Collection

Docker

Self-hosted API docker image can be found on our official dockerhub page.

Docker environment variables

Environment variables are for the current version and may differ for a previous versions.

Mandatory variables are marked with an asterisk (*).

Variable Description Type Default value
LICENSEE* Your licensee String
LICENSE_KEY* Your license key String
PORT Exposed port for API Integer 8080
MAX_REQUEST_SIZE Max http request size String 100MB
GRACEFUL_SHUTDOWN_TIMEOUT Graceful shutdown timeout in duration format. Duration PT15S
WRAPPER_PATH Path for wrapper to override autoconfiguration. Can be used if you want to skip automatic CPU architecture detection. String
WORKER_TIMEOUT_MS Max time waiting for a recognition process to finish. Integer 20000
WORKERS_POOL_SIZE Number of recognition workers in a worker pool. Integer 2
WORKER_CREATION_MS Milliseconds to wait for license check at startup. Lower values will result in faster startup but invalid license will be reported on requests. Integer 100
AVAILABLE_WORKER_TIMEOUT_MS Max time waiting to get available recognition worker from the pool. Integer 10000
ENABLE_METRICS Enable metrics endpoint. Boolean false
ENABLE_HEALTH_ENDPOINTS Enable health, liveness and readiness endpoints. Boolean true
ENABLE_SECURITY Enable basic security. Boolean false
BASIC_AUTH_USERNAME Username for Basic authentication header. String
BASIC_AUTH_PASSWORD Password for Basic authentication header. String
IMAGE_ALLOW_INVALID_CERTIFICATE Whether to allow download of images from Url with invalid certificate. Boolean true
IMAGE_DOWNLOAD_TIMEOUT Max time for image download from provided image Url. Integer 10000
IMAGE_MAX_SIZE_KB Max image size in kilobytes. Empty value means unlimited. Integer
IMAGE_URL_PROTOCOLS_ALLOWED Allowed protocols for image download. Comma-separated string http,https
IMAGE_URL_HOSTS_ALLOWED Allowed hosts for image download. Empty value means all hosts are allowed. Comma-separated string
IMAGE_URL_PORTS_ALLOWED Allowed ports for image download. Empty value means all ports are allowed. Comma-separated integer
IMAGE_URL_DIRECTORIES_ALLOWED Allowed directories for image download. Empty value means all directories are allowed. Works only if file protocol is specified. Comma-separated string
ENABLE_REQUEST_SUMMARY Whether to enable request summary in log. Boolean true
PING_INTERVAL Interval for ping statistics. Used for licenses with ping. Integer 25
LOG_ENABLE_CUSTOMIZATION Whether to allow logger customizations. Boolean false
LOG_ENABLE_CONSOLE_APPENDER Whether to enable console appender. Boolean true
LOG_ENABLE_FILE_APPENDER Whether to enable file appender. Log files are placed inside docker container in /logs folder. Boolean false
LOG_PATTERN Custom pattern for logback. You can use %X{traceId} and %X{executionId} from MDC to track request. String
LOGGER_MAP Logger key-values pairs. For more detailed logging provide "com.microblink=DEBUG,io.micronaut=INFO" Comma-separated string=string pairs
ALLOW_CORS Whether to enable CORS. Boolean true
ALLOWED_METHODS CORS allowed methods. Comma-separated string GET,POST,OPTIONS
ALLOWED_ORIGINS CORS allowed origins. Empty value means all origins are allowed. Comma-separated string
PROXY_HOST The host name of the proxy server. String
PROXY_PORT The port number of the proxy server. Integer
TRUST_STORE Trust store path. String
TRUST_STORE_PASSWORD Trust store password. Needed only if a trust store is password protected. String

Docker compose

Minimal docker compose sample can be found here

Recommended Docker runtime options for throughput of 1.5 req/s are 4 CPUs, 4 GB of memory and 2 workers (WORKERS_POOL_SIZE).

Basic Authentication

Self-hosted API currently supports basic authentication. To enable it set docker environemnt variable ENABLE_SECURITY to true, and provide BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD environemnt variables. After setup all recognition endpoints require Authentication header in form:

Authorization: 'Basic ' + Base64.encode(username + ':' + password)

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

Recognition endpoints

Barcode

Code samples

# You can also use wget
curl -X POST /barcode \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

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

r = requests.post('/barcode', headers = headers)

print(r.json())

const inputBody = '{
  "autoScaleDetection": true,
  "nullQuietZoneAllowed": false,
  "readCode39AsExtendedData": false,
  "scanCode128": false,
  "scanCode39": false,
  "scanEan13": false,
  "scanEan8": false,
  "scanInverse": false,
  "scanItf": false,
  "scanPdf417": false,
  "scanQrCode": false,
  "scanUncertain": true,
  "scanUpca": false,
  "scanUpce": false,
  "slowerThoroughScan": false,
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/barcode',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/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 = "/barcode";

      string json = @"{
  ""autoScaleDetection"": true,
  ""nullQuietZoneAllowed"": false,
  ""readCode39AsExtendedData"": false,
  ""scanCode128"": false,
  ""scanCode39"": false,
  ""scanEan13"": false,
  ""scanEan8"": false,
  ""scanInverse"": false,
  ""scanItf"": false,
  ""scanPdf417"": false,
  ""scanQrCode"": false,
  ""scanUncertain"": true,
  ""scanUpca"": false,
  ""scanUpce"": false,
  ""slowerThoroughScan"": false,
  ""image"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""traceId"": ""string""
}";
      BarcodeRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(BarcodeRequest 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(BarcodeRequest 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 /barcode

Body parameter

{
  "autoScaleDetection": true,
  "nullQuietZoneAllowed": false,
  "readCode39AsExtendedData": false,
  "scanCode128": false,
  "scanCode39": false,
  "scanEan13": false,
  "scanEan8": false,
  "scanInverse": false,
  "scanItf": false,
  "scanPdf417": false,
  "scanQrCode": false,
  "scanUncertain": true,
  "scanUpca": false,
  "scanUpce": false,
  "slowerThoroughScan": false,
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}

Parameters

Name In Type Required Description
body body BarcodeRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "barcodeType": "NONE",
    "rawData": "string",
    "stringData": "string",
    "uncertain": true,
    "detectionPoints": {
      "points": [
        {
          "x": 0,
          "y": 0
        }
      ]
    },
    "recognitionStatus": "EMPTY"
  }
}

Responses

Status Meaning Description Schema
200 OK recognize 200 response BarcodeEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

Code samples

# You can also use wget
curl -X POST /blinkcard \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

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

r = requests.post('/blinkcard', headers = headers)

print(r.json())

const inputBody = '{
  "extractIban": true,
  "extractExpiryDate": true,
  "extractOwner": true,
  "extractCvv": true,
  "returnFullDocumentImage": false,
  "anonymizationSettings": {
    "cardNumberAnonymizationSettings": {
      "anonymizationMode": "NONE",
      "prefixDigitsVisible": 0,
      "suffixDigitsVisible": 0
    },
    "cardNumberPrefixAnonymizationMode": "NONE",
    "cvvAnonymizationMode": "NONE",
    "ibanAnonymizationMode": "NONE",
    "ownerAnonymizationMode": "NONE"
  },
  "allowBlurFilter": false,
  "cardNumberSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "otherSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/blinkcard',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/blinkcard");
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 = "/blinkcard";

      string json = @"{
  ""extractIban"": true,
  ""extractExpiryDate"": true,
  ""extractOwner"": true,
  ""extractCvv"": true,
  ""returnFullDocumentImage"": false,
  ""anonymizationSettings"": {
    ""cardNumberAnonymizationSettings"": {
      ""anonymizationMode"": ""NONE"",
      ""prefixDigitsVisible"": 0,
      ""suffixDigitsVisible"": 0
    },
    ""cardNumberPrefixAnonymizationMode"": ""NONE"",
    ""cvvAnonymizationMode"": ""NONE"",
    ""ibanAnonymizationMode"": ""NONE"",
    ""ownerAnonymizationMode"": ""NONE""
  },
  ""allowBlurFilter"": false,
  ""cardNumberSide"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""otherSide"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""traceId"": ""string""
}";
      BlinkCardRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(BlinkCardRequest 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(BlinkCardRequest 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 /blinkcard

Body parameter

{
  "extractIban": true,
  "extractExpiryDate": true,
  "extractOwner": true,
  "extractCvv": true,
  "returnFullDocumentImage": false,
  "anonymizationSettings": {
    "cardNumberAnonymizationSettings": {
      "anonymizationMode": "NONE",
      "prefixDigitsVisible": 0,
      "suffixDigitsVisible": 0
    },
    "cardNumberPrefixAnonymizationMode": "NONE",
    "cvvAnonymizationMode": "NONE",
    "ibanAnonymizationMode": "NONE",
    "ownerAnonymizationMode": "NONE"
  },
  "allowBlurFilter": false,
  "cardNumberSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "otherSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}
Name In Type Required Description
body body BlinkCardRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "cardIssuer": "ISSUER_OTHER",
    "cardNumber": "string",
    "cardNumberValid": true,
    "cardNumberPrefix": "string",
    "iban": "string",
    "cvv": "string",
    "expiryDate": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "owner": "string",
    "firstSideFullDocumentImage": "string",
    "secondSideFullDocumentImage": "string",
    "firstSideBlurred": true,
    "secondSideBlurred": true,
    "processingStatus": "SUCCESS",
    "scanningFirstSideDone": true,
    "recognitionStatus": "EMPTY"
  }
}
Status Meaning Description Schema
200 OK recognize_1 200 response BlinkCardEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

BlinkID

Code samples

# You can also use wget
curl -X POST /blinkid \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

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

r = requests.post('/blinkid', headers = headers)

print(r.json())

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

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

URL obj = new URL("/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 = "/blinkid";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""NONE"",
  ""ageLimit"": 0,
  ""image"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""scanCroppedDocumentImage"": false,
  ""traceId"": ""string""
}";
      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 /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": "NONE",
  "ageLimit": 0,
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "scanCroppedDocumentImage": false,
  "traceId": "string"
}

Parameters

Name In Type Required Description
body body BlinkIdRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          }
        }
      ]
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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"
    },
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
    "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"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": "string",
    "mothersName": "string",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Responses

Status Meaning Description Schema
200 OK recognize_2 200 response BlinkIdEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

BlinkID Combined

Code samples

# You can also use wget
curl -X POST /blinkid-combined \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

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

r = requests.post('/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": "NONE",
  "imageFront": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "imageBack": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "ageLimit": 0,
  "scanCroppedDocumentImage": false,
  "maxAllowedMismatchesPerField": 0,
  "allowUncertainFrontSideScan": true,
  "traceId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

URL obj = new URL("/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 = "/blinkid-combined";

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": false,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""skipUnsupportedBack"": false,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""NONE"",
  ""imageFront"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""imageBack"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""ageLimit"": 0,
  ""scanCroppedDocumentImage"": false,
  ""maxAllowedMismatchesPerField"": 0,
  ""allowUncertainFrontSideScan"": true,
  ""traceId"": ""string""
}";
      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 /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": "NONE",
  "imageFront": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "imageBack": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "ageLimit": 0,
  "scanCroppedDocumentImage": false,
  "maxAllowedMismatchesPerField": 0,
  "allowUncertainFrontSideScan": true,
  "traceId": "string"
}

Parameters

Name In Type Required Description
body body BlinkIdCombinedRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          }
        }
      ]
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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"
    },
    "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",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            }
          }
        ]
      }
    },
    "backViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
    "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"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": "string",
    "mothersName": "string",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Responses

Status Meaning Description Schema
200 OK recognize_3 200 response BlinkIdCombinedEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

IDBarcode

Code samples

# You can also use wget
curl -X POST /id-barcode \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

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

r = requests.post('/id-barcode', headers = headers)

print(r.json())

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

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

URL obj = new URL("/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 = "/id-barcode";

      string json = @"{
  ""image"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""inputString"": ""string"",
  ""ageLimit"": 0,
  ""traceId"": ""string""
}";
      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 /id-barcode

Scanning barcodes on supported documents.

Body parameter

{
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "inputString": "string",
  "ageLimit": 0,
  "traceId": "string"
}

Parameters

Name In Type Required Description
body body IdBarcodeRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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"
      }
    ],
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "recognitionStatus": "EMPTY",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Responses

Status Meaning Description Schema
200 OK recognize_4 200 response IdBarcodeEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

Management Endpoints

getHealth

Code samples

# You can also use wget
curl -X GET /health \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/health', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/json'
};

fetch('/health',
{
  method: 'GET',

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

URL obj = new URL("/health");
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 = "/health";
      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 /health

Example responses

200 Response

[
  {
    "name": "string",
    "status": {
      "name": "string",
      "description": "string",
      "operational": true,
      "severity": 0
    },
    "details": {}
  }
]

Responses

Status Meaning Description Schema
200 OK getHealth 200 response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [HealthResult] false none none
» name string false none none
» status HealthStatus false none none
»» name string true none none
»» description string true none none
»» operational boolean true none none
»» severity integer(int32) true none none
» details Object false none none

getHealth_1

Code samples

# You can also use wget
curl -X GET /health/{selector} \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/health/{selector}', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/json'
};

fetch('/health/{selector}',
{
  method: 'GET',

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

URL obj = new URL("/health/{selector}");
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 = "/health/{selector}";
      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 /health/{selector}

Parameters

Name In Type Required Description
selector path HealthCheckType true none

Enumerated Values

Parameter Value
selector LIVENESS
selector READINESS

Example responses

200 Response

[
  {
    "name": "string",
    "status": {
      "name": "string",
      "description": "string",
      "operational": true,
      "severity": 0
    },
    "details": {}
  }
]

Responses

Status Meaning Description Schema
200 OK getHealth_1 200 response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [HealthResult] false none none
» name string false none none
» status HealthStatus false none none
»» name string true none none
»» description string true none none
»» operational boolean true none none
»» severity integer(int32) true none none
» details Object false none none

getInfo

Code samples

# You can also use wget
curl -X GET /info \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/info', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/json'
};

fetch('/info',
{
  method: 'GET',

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

URL obj = new URL("/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 = "/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 /info

Example responses

200 Response

[
  {}
]

Responses

Status Meaning Description Schema
200 OK getInfo 200 response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Object] false none none

Schemas

AddressDetailedInfo

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

The details about the address.

Properties

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

AnonymizationMode

"NONE"

Anonymization mode

Properties

Name Type Required Restrictions Description
Anonymization mode string false none Level of anonymization performed on recognizer result.

Enumerated Values

Property Value
Anonymization mode NONE
Anonymization mode IMAGE_ONLY
Anonymization mode RESULT_FIELDS_ONLY
Anonymization mode FULL_RESULT

AnonymizationSettings

{
  "cardNumberAnonymizationSettings": {
    "anonymizationMode": "NONE",
    "prefixDigitsVisible": 0,
    "suffixDigitsVisible": 0
  },
  "cardNumberPrefixAnonymizationMode": "NONE",
  "cvvAnonymizationMode": "NONE",
  "ibanAnonymizationMode": "NONE",
  "ownerAnonymizationMode": "NONE"
}

Whether sensitive data should be redacted from the result.

Properties

Name Type Required Restrictions Description
cardNumberAnonymizationSettings any false none none

allOf

Name Type Required Restrictions Description
» anonymous CardNumberAnonymizationSettings false none Parameters of card number anonymization

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
cardNumberPrefixAnonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
cvvAnonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
ibanAnonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
ownerAnonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

BarcodeElement

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

Properties

Name Type Required Restrictions Description
key any false none none

allOf

Name Type Required Restrictions Description
» anonymous BarcodeElementKey false none Additional fields present in the barcode.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
value string¦null false none none

BarcodeElementKey

"BARCODE_ELEMENT_KEY_DOCUMENT_TYPE"

Barcode element key

Properties

Name Type Required Restrictions Description
Barcode element key string false none Additional fields present in the barcode.

Enumerated Values

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

BarcodeEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "barcodeType": "NONE",
    "rawData": "string",
    "stringData": "string",
    "uncertain": true,
    "detectionPoints": {
      "points": [
        {
          "x": 0,
          "y": 0
        }
      ]
    },
    "recognitionStatus": "EMPTY"
  }
}

Properties

Name Type Required Restrictions Description
traceId string¦null false none none
executionId string true none none
finishTime string(date-time) true none UTC time after recognition finished.
startTime string(date-time) true none UTC time before recognition started.
data BarcodeRecognizerOutput true none none

BarcodeRecognizerOutput

{
  "barcodeType": "NONE",
  "rawData": "string",
  "stringData": "string",
  "uncertain": true,
  "detectionPoints": {
    "points": [
      {
        "x": 0,
        "y": 0
      }
    ]
  },
  "recognitionStatus": "EMPTY"
}

Properties

Name Type Required Restrictions Description
barcodeType any false none none

allOf

Name Type Required Restrictions Description
» anonymous BarcodeType false none Type of barcode.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
rawData string¦null false none Byte array with result of the scan.
stringData string¦null false none Retrieves string content of scanned data.
uncertain boolean¦null false none Flag indicating uncertain scanning data.
detectionPoints any false none none

allOf

Name Type Required Restrictions Description
» anonymous DetectionPoints false none Points array with coordinates of barcode detection.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionStatus ResultState true none Possible states of the Recognizer's result.

BarcodeRequest

{
  "autoScaleDetection": true,
  "nullQuietZoneAllowed": false,
  "readCode39AsExtendedData": false,
  "scanCode128": false,
  "scanCode39": false,
  "scanEan13": false,
  "scanEan8": false,
  "scanInverse": false,
  "scanItf": false,
  "scanPdf417": false,
  "scanQrCode": false,
  "scanUncertain": true,
  "scanUpca": false,
  "scanUpce": false,
  "slowerThoroughScan": false,
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}

Request body for Barcode recognition.

Properties

Name Type Required Restrictions Description
autoScaleDetection boolean¦null false none Allow enabling the autodetection of image scale when scanning barcodes. If set to true, prior reading barcode, image scale will be corrected. This enabled correct reading of barcodes on high resolution images but slows down the recognition process. This setting is applied only for Code39 and Code128 barcode scanning. Default TRUE
nullQuietZoneAllowed boolean¦null false none Set this to true to scan barcodes which don't have quiet zone (white area) around it. Use only if necessary because it slows down the recognition process Default FALSE
readCode39AsExtendedData boolean¦null false none Enable reading code39 barcode contents as extended data. For more information about code39 extended data (a.k.a. full ASCII mode), see https://en.wikipedia.org/wiki/Code_39#Full_ASCII_Code_39 Default FALSE
scanCode128 boolean¦null false none Set this to true to scan Code 128 1D barcodes. Default FALSE
scanCode39 boolean¦null false none Set this to true to scan Code 39 1D barcodes. Default FALSE
scanEan13 boolean¦null false none Set this to true to scan EAN 13 barcodes. Default FALSE
scanEan8 boolean¦null false none Set this to true to scan EAN8 barcodes. Default FALSE
scanInverse boolean¦null false none Set this to true to allow scanning barcodes with inverted intensities. This options doubles the frame processing time. Default FALSE
scanItf boolean¦null false none Set this to true to scan ITF barcodes. Default FALSE
scanPdf417 boolean¦null false none Set this to true to scan Pdf417 barcodes. Default FALSE
scanQrCode boolean¦null false none Set this to true to scan QR barcodes. Default FALSE
scanUncertain boolean¦null false none Set this to true to scan even barcode not compliant with standards. For example, malformed PDF417 barcodes which were incorrectly encoded. Use only if necessary because it slows down the recognition process. Default TRUE
scanUpca boolean¦null false none Set this to true to scan UPCA barcodes. Default FALSE
scanUpce boolean¦null false none Set this to true to scan UPCE barcodes. Default FALSE
slowerThoroughScan boolean¦null false none Set this to true to allow slower, but better image processing. Default FALSE
image any true none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
traceId string¦null false none none

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",
    "vehicleClassesInfo": [
      {
        "vehicleClass": "string",
        "licenceType": "string",
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        }
      }
    ]
  },
  "extendedElements": [
    {
      "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
      "value": "string"
    }
  ]
}

The data extracted from the barcode.

Properties

Name Type Required Restrictions Description
rawDataBase64 string¦null false none The raw bytes contained inside barcode.
stringData string¦null false none String representation of data inside barcode.
firstName string¦null false none The first name of the document owner.
lastName string¦null false none The last name of the document owner.
middleName string¦null false none The middle name of the document owner.
fullName string¦null false none The full name of the document owner.
additionalNameInformation string¦null false none The additional name information of the document owner.
address string¦null false none The address of the document owner.
placeOfBirth string¦null false none The place of birth of the document owner.
nationality string¦null false none The nationality of the documet owner.
race string¦null false none The race of the document owner.
religion string¦null false none The religion of the document owner.
profession string¦null false none The profession of the document owner.
maritalStatus string¦null false none The marital status of the document owner.
residentialStatus string¦null false none The residential stauts of the document owner.
employer string¦null false none The employer of the document owner.
sex string¦null false none The sex of the document owner.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfIssue any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentNumber string¦null false none The document number.
personalIdNumber string¦null false none The personal identification number.
documentAdditionalNumber string¦null false none The additional number of the document.
issuingAuthority string¦null false none The issuing authority of the document.
addressDetailedInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous AddressDetailedInfo false none The details about the address.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
driverLicenseDetailedInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous DriverLicenseDetailedInfo false none The driver license detailed info.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
extendedElements [BarcodeElement]¦null false none Document specific extended elements that contain all barcode fields in their original form.

BarcodeType

"NONE"

Barcode type

Properties

Name Type Required Restrictions Description
Barcode type string false none Type of barcode.

Enumerated Values

Property Value
Barcode type NONE
Barcode type QR_CODE
Barcode type UPC_E
Barcode type UPC_A
Barcode type EAN_8
Barcode type EAN_13
Barcode type CODE_128
Barcode type CODE_39
Barcode type ITF
Barcode type PDF417_BARCODE

BlinkCardEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "cardIssuer": "ISSUER_OTHER",
    "cardNumber": "string",
    "cardNumberValid": true,
    "cardNumberPrefix": "string",
    "iban": "string",
    "cvv": "string",
    "expiryDate": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "owner": "string",
    "firstSideFullDocumentImage": "string",
    "secondSideFullDocumentImage": "string",
    "firstSideBlurred": true,
    "secondSideBlurred": true,
    "processingStatus": "SUCCESS",
    "scanningFirstSideDone": true,
    "recognitionStatus": "EMPTY"
  }
}

Properties

Name Type Required Restrictions Description
traceId string¦null false none none
executionId string true none none
finishTime string(date-time) true none UTC time after recognition finished.
startTime string(date-time) true none UTC time before recognition started.
data BlinkCardRecognizerOutput true none none

BlinkCardProcessingStatus

"SUCCESS"

BlinkCard processing status

Properties

Name Type Required Restrictions Description
BlinkCard processing status string false none Processing status of BlinkCard.

Enumerated Values

Property Value
BlinkCard processing status SUCCESS
BlinkCard processing status DETECTION_FAILED
BlinkCard processing status IMAGE_PREPROCESSING_FAILED
BlinkCard processing status STABILITY_TEST_FAILED
BlinkCard processing status SCANNING_WRONG_SIDE
BlinkCard processing status FIELD_IDENTIFICATION_FAILED
BlinkCard processing status IMAGE_RETURN_FAILED
BlinkCard processing status UNSUPPORTED_CARD

BlinkCardRecognizerOutput

{
  "cardIssuer": "ISSUER_OTHER",
  "cardNumber": "string",
  "cardNumberValid": true,
  "cardNumberPrefix": "string",
  "iban": "string",
  "cvv": "string",
  "expiryDate": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "owner": "string",
  "firstSideFullDocumentImage": "string",
  "secondSideFullDocumentImage": "string",
  "firstSideBlurred": true,
  "secondSideBlurred": true,
  "processingStatus": "SUCCESS",
  "scanningFirstSideDone": true,
  "recognitionStatus": "EMPTY"
}

Properties

Name Type Required Restrictions Description
cardIssuer CardIssuer true none Supported issuing institutions that issued the card to the card holder.
cardNumber string¦null false none The payment card number.
cardNumberValid boolean¦null false none The payment card number validity
cardNumberPrefix string¦null false none The payment card number prefix.
iban string¦null false none Payment card's IBAN.
cvv string¦null false none Payment card's security code/value.
expiryDate any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
owner string¦null false none Information about the payment card owner.
firstSideFullDocumentImage string¦null false none Full image of the payment card from first side recognition.
secondSideFullDocumentImage string¦null false none Full image of the payment card from second side recognition.
firstSideBlurred boolean¦null false none Wheater the first scanned side is blurred.
secondSideBlurred boolean¦null false none Wheater the second scanned side is blurred.
processingStatus BlinkCardProcessingStatus true none Processing status of BlinkCard.
scanningFirstSideDone boolean¦null false none Whether the scanning of the first side is finished.
recognitionStatus ResultState true none Possible states of the Recognizer's result.

BlinkCardRequest

{
  "extractIban": true,
  "extractExpiryDate": true,
  "extractOwner": true,
  "extractCvv": true,
  "returnFullDocumentImage": false,
  "anonymizationSettings": {
    "cardNumberAnonymizationSettings": {
      "anonymizationMode": "NONE",
      "prefixDigitsVisible": 0,
      "suffixDigitsVisible": 0
    },
    "cardNumberPrefixAnonymizationMode": "NONE",
    "cvvAnonymizationMode": "NONE",
    "ibanAnonymizationMode": "NONE",
    "ownerAnonymizationMode": "NONE"
  },
  "allowBlurFilter": false,
  "cardNumberSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "otherSide": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "traceId": "string"
}

Request body for Blink Card recognition.

Properties

Name Type Required Restrictions Description
extractIban boolean¦null false none Should extract the payment card's IBAN. Default TRUE
extractExpiryDate boolean¦null false none Defines whether the expiry date should be extracted. Default TRUE
extractOwner boolean¦null false none Should extract the card owner information. Default TRUE
extractCvv boolean¦null false none Defines whether the cvv should be extracted. Default TRUE
returnFullDocumentImage boolean¦null false none Defines whether full document image should be extracted. Default FALSE
anonymizationSettings any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationSettings false none Whether sensitive data should be redacted from the result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
allowBlurFilter boolean¦null false none Defines whether blurred frames filtering is allowed. Default FALSE
cardNumberSide any true none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
otherSide any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
traceId string¦null false none none

BlinkIdCombinedEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          }
        }
      ]
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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"
    },
    "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",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            }
          }
        ]
      }
    },
    "backViz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
    "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"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": "string",
    "mothersName": "string",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Properties

Name Type Required Restrictions Description
traceId string¦null false none none
executionId string true none none
finishTime string(date-time) true none UTC time after recognition finished.
startTime string(date-time) true none UTC time before recognition started.
data BlinkIdCombinedRecognizerOutput true none none

BlinkIdCombinedRecognizerOutput

{
  "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",
    "vehicleClassesInfo": [
      {
        "vehicleClass": "string",
        "licenceType": "string",
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        }
      }
    ]
  },
  "fullDocumentFrontImageBase64": "string",
  "fullDocumentBackImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": "string",
  "additionalAddressInformation": "string",
  "additionalOptionalAddressInformation": "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"
  },
  "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",
    "additionalOptionalAddressInformation": "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",
    "fathersName": "string",
    "mothersName": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          }
        }
      ]
    }
  },
  "backViz": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "localizedName": "string",
    "address": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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",
    "fathersName": "string",
    "mothersName": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "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",
  "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"
  },
  "recognitionStatus": "EMPTY",
  "fathersName": "string",
  "mothersName": "string",
  "isBelowAgeLimit": true,
  "age": 0
}

Properties

Name Type Required Restrictions Description
firstName string¦null false none The first name of the document owner.
lastName string¦null false none The last name of the document owner.
fullName string¦null false none The last name of the document owner.
address string¦null false none The address of the document owner.
dateOfIssue any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentNumber string¦null false none The document number.
sex string¦null false none The sex of the document owner.
driverLicenseDetailedInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous DriverLicenseDetailedInfo false none The driver license detailed info.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
fullDocumentFrontImageBase64 string¦null false none The full document front image.
fullDocumentBackImageBase64 string¦null false none The full document front image.
faceImageBase64 string¦null false none The face image.
additionalNameInformation string¦null false none The additional name information of the document owner.
additionalAddressInformation string¦null false none The additional address information of the document owner.
additionalOptionalAddressInformation string¦null false none The one more additional address information of the document owner.
placeOfBirth string¦null false none The place of birth of the document owner.
nationality string¦null false none The nationality of the documet owner.
race string¦null false none The race of the document owner.
religion string¦null false none The religion of the document owner.
profession string¦null false none The profession of the document owner.
maritalStatus string¦null false none The marital status of the document owner.
residentialStatus string¦null false none The residential stauts of the document owner.
employer string¦null false none The employer of the document owner.
personalIdNumber string¦null false none The personal identification number.
documentAdditionalNumber string¦null false none The additional number of the document.
documentOptionalAdditionalNumber string¦null false none The one more additional number of the document.
issuingAuthority string¦null false none The issuing authority of the document.
mrzData any false none none

allOf

Name Type Required Restrictions Description
» anonymous MrzResult false none The data extracted from the machine readable zone.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
localizedName string¦null false none The localized name of the document.
dataMatchResult any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchResult false none We currently check document number, date of expiry, date of birth and date of issue fields.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiryPermanent boolean¦null false none Determines if date of expiry is permanent.
scanningFirstSideDone boolean¦null false none Defines whether recognizer has finished scanning first side.
additionalPersonalIdNumber string¦null false none The additional personal identification number.
frontViz any false none none

allOf

Name Type Required Restrictions Description
» anonymous VIZResult false none The data extracted from the visual inspection zone.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
backViz any false none none

allOf

Name Type Required Restrictions Description
» anonymous VIZResult false none The data extracted from the visual inspection zone.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
barcode any false none none

allOf

Name Type Required Restrictions Description
» anonymous BarcodeResult false none The data extracted from the barcode.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
frontImageAnalysisResult any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisResult false none Various information obtained by analysing the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
backImageAnalysisResult any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisResult false none Various information obtained by analysing the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
processingStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ProcessingStatus false none Detailed information about the recognition process.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
frontProcessingStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ProcessingStatus false none Detailed information about the recognition process.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
backProcessingStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ProcessingStatus false none Detailed information about the recognition process.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous RecognitionMode false none Recognition mode used to scan current document.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
signatureImageBase64 string¦null false none The signature image.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
classInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous ClassInfo false none The document class information.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionStatus ResultState true none Possible states of the Recognizer's result.
fathersName string¦null false none The fathers name of the document owner.
mothersName string¦null false none The mothers name of the document owner.
isBelowAgeLimit boolean¦null 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)¦null false none The calculated age of the document owner.

BlinkIdCombinedRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "NONE",
  "imageFront": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "imageBack": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "ageLimit": 0,
  "scanCroppedDocumentImage": false,
  "maxAllowedMismatchesPerField": 0,
  "allowUncertainFrontSideScan": true,
  "traceId": "string"
}

Request body for Blink Id Combined recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean¦null false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean¦null false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean¦null false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean¦null false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean¦null false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean¦null false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
skipUnsupportedBack boolean¦null false none Skip back side capture and processing step when back side of the document is not supported. Default FALSE
validateResultCharacters boolean¦null false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
imageFront any true none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
imageBack any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
ageLimit integer(int32)¦null false none Defines the age limit for age verification.
scanCroppedDocumentImage boolean¦null false none Configure the recognizer to only work on already cropped and dewarped images. Default FALSE
maxAllowedMismatchesPerField integer(int32)¦null false none Configure the number of characters per field that are allowed to be inconsistent in data match. Default 0
allowUncertainFrontSideScan boolean¦null false none Proceed with scanning the back side even if the front side result is uncertain. Default TRUE
traceId string¦null false none none

BlinkIdEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          }
        }
      ]
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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"
    },
    "localizedName": "string",
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": "string",
    "viz": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "additionalNameInformation": "string",
      "localizedName": "string",
      "address": "string",
      "additionalAddressInformation": "string",
      "additionalOptionalAddressInformation": "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",
      "fathersName": "string",
      "mothersName": "string",
      "driverLicenseDetailedInfo": {
        "restrictions": "string",
        "endorsements": "string",
        "vehicleClass": "string",
        "conditions": "string",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
        "vehicleClassesInfo": [
          {
            "vehicleClass": "string",
            "licenceType": "string",
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "originalString": "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",
    "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"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": "string",
    "mothersName": "string",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Properties

Name Type Required Restrictions Description
traceId string¦null false none none
executionId string true none none
finishTime string(date-time) true none UTC time after recognition finished.
startTime string(date-time) true none UTC time before recognition started.
data BlinkIdRecognizerOutput true none none

BlinkIdRecognizerOutput

{
  "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",
    "vehicleClassesInfo": [
      {
        "vehicleClass": "string",
        "licenceType": "string",
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        }
      }
    ]
  },
  "fullDocumentImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": "string",
  "additionalAddressInformation": "string",
  "additionalOptionalAddressInformation": "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"
  },
  "localizedName": "string",
  "dateOfExpiryPermanent": true,
  "additionalPersonalIdNumber": "string",
  "viz": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "additionalNameInformation": "string",
    "localizedName": "string",
    "address": "string",
    "additionalAddressInformation": "string",
    "additionalOptionalAddressInformation": "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",
    "fathersName": "string",
    "mothersName": "string",
    "driverLicenseDetailedInfo": {
      "restrictions": "string",
      "endorsements": "string",
      "vehicleClass": "string",
      "conditions": "string",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "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",
      "vehicleClassesInfo": [
        {
          "vehicleClass": "string",
          "licenceType": "string",
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "originalString": "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",
  "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"
  },
  "recognitionStatus": "EMPTY",
  "fathersName": "string",
  "mothersName": "string",
  "isBelowAgeLimit": true,
  "age": 0
}

Properties

Name Type Required Restrictions Description
firstName string¦null false none The first name of the document owner.
lastName string¦null false none The last name of the document owner.
fullName string¦null false none The full name of the document owner.
address string¦null false none The address of the document owner.
dateOfIssue any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentNumber string¦null false none The document number.
sex string¦null false none The sex of the document owner.
driverLicenseDetailedInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous DriverLicenseDetailedInfo false none The driver license detailed info.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
fullDocumentImageBase64 string¦null false none The full document image.
faceImageBase64 string¦null false none The face image.
additionalNameInformation string¦null false none The additional name information of the document owner.
additionalAddressInformation string¦null false none The additional address information of the document owner.
additionalOptionalAddressInformation string¦null false none The one more additional address information of the document owner.
placeOfBirth string¦null false none The place of birth of the document owner.
nationality string¦null false none The nationality of the documet owner.
race string¦null false none The race of the document owner.
religion string¦null false none The religion of the document owner.
profession string¦null false none The profession of the document owner.
maritalStatus string¦null false none The marital status of the document owner.
residentialStatus string¦null false none The residential stauts of the document owner.
employer string¦null false none The employer of the document owner.
personalIdNumber string¦null false none The personal identification number.
documentAdditionalNumber string¦null false none The additional number of the document.
documentOptionalAdditionalNumber string¦null false none The one more additional number of the document.
issuingAuthority string¦null false none The issuing authority of the document.
mrzData any false none none

allOf

Name Type Required Restrictions Description
» anonymous MrzResult false none The data extracted from the machine readable zone.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
localizedName string¦null false none The localized name of the document.
dateOfExpiryPermanent boolean¦null false none Determines if date of expiry is permanent.
additionalPersonalIdNumber string¦null false none The additional personal identification number.
viz any false none none

allOf

Name Type Required Restrictions Description
» anonymous VIZResult false none The data extracted from the visual inspection zone.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
barcode any false none none

allOf

Name Type Required Restrictions Description
» anonymous BarcodeResult false none The data extracted from the barcode.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
imageAnalysisResult any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisResult false none Various information obtained by analysing the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
processingStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ProcessingStatus false none Detailed information about the recognition process.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous RecognitionMode false none Recognition mode used to scan current document.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
signatureImageBase64 string¦null false none The signature image.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
classInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous ClassInfo false none The document class information.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionStatus ResultState true none Possible states of the Recognizer's result.
fathersName string¦null false none The fathers name of the document owner.
mothersName string¦null false none The mothers name of the document owner.
isBelowAgeLimit boolean¦null 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)¦null false none The calculated age of the document owner.

BlinkIdRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": false,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "NONE",
  "ageLimit": 0,
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "scanCroppedDocumentImage": false,
  "traceId": "string"
}

Request body for Blink Id recognition.

Properties

Name Type Required Restrictions Description
returnFullDocumentImage boolean¦null false none Defines whether full document image should be extracted. Default FALSE
returnFaceImage boolean¦null false none Defines whether face image should be extracted. Default FALSE
returnSignatureImage boolean¦null false none Defines whether signature image should be extracted. Default FALSE
allowBlurFilter boolean¦null false none Defines whether blurred frames filtering is allowed. Default FALSE
allowUnparsedMrzResults boolean¦null false none Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. Default FALSE
allowUnverifiedMrzResults boolean¦null false none Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Default TRUE
validateResultCharacters boolean¦null false none Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE
anonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
ageLimit integer(int32)¦null false none Defines the age limit for age verification.
image any true none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
scanCroppedDocumentImage boolean¦null false none Configure the recognizer to only work on already cropped and dewarped images. Default FALSE
traceId string¦null false none none

CardIssuer

"ISSUER_OTHER"

Card issuer

Properties

Name Type Required Restrictions Description
Card issuer string false none Supported issuing institutions that issued the card to the card holder.

Enumerated Values

Property Value
Card issuer ISSUER_OTHER
Card issuer ISSUER_AMERICAN_EXPRESS
Card issuer ISSUER_CHINA_UNION_PAY
Card issuer ISSUER_DINERS
Card issuer ISSUER_DISCOVER_CARD
Card issuer ISSUER_ELO
Card issuer ISSUER_JCB
Card issuer ISSUER_MAESTRO
Card issuer ISSUER_MASTER_CARD
Card issuer ISSUER_RU_PAY
Card issuer ISSUER_VERVE
Card issuer ISSUER_VISA
Card issuer ISSUER_VPAY

CardNumberAnonymizationSettings

{
  "anonymizationMode": "NONE",
  "prefixDigitsVisible": 0,
  "suffixDigitsVisible": 0
}

Parameters of card number anonymization

Properties

Name Type Required Restrictions Description
anonymizationMode any false none none

allOf

Name Type Required Restrictions Description
» anonymous AnonymizationMode false none Level of anonymization performed on recognizer result.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
prefixDigitsVisible integer(int32)¦null false none Defines how many digits at the beginning of the card number remain visible after anonymization.. Default 0
suffixDigitsVisible integer(int32)¦null false none Defines how many digits at the end of the card number remain visible after anonymization. Default 0

ClassInfo

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

The document class information.

Properties

Name Type Required Restrictions Description
country any false none none

allOf

Name Type Required Restrictions Description
» anonymous Country false none Document country.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
region any false none none

allOf

Name Type Required Restrictions Description
» anonymous Region false none Document region.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
type any false none none

allOf

Name Type Required Restrictions Description
» anonymous Type false none Document type.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

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

Country

"COUNTRY_NONE"

Country

Properties

Name Type Required Restrictions Description
Country string false none Document country.

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_ESWATINI
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

DataMatchResult

"NOT_PERFORMED"

Data match result

Properties

Name Type Required Restrictions Description
Data match result string false none We currently check document number, date of expiry, date of birth and date of issue fields.

Enumerated Values

Property Value
Data match result NOT_PERFORMED
Data match result FAILED
Data match result SUCCESS

DateResult

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

Properties

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

DefaultResponse

{
  "message": "string",
  "traceId": "string",
  "executionId": "string"
}

Response type for exceptions.

Properties

Name Type Required Restrictions Description
message string¦null false none Exception message
traceId string¦null false none Provided identifier
executionId string true none Unique execution identifier

DetectionPoints

{
  "points": [
    {
      "x": 0,
      "y": 0
    }
  ]
}

Points array with coordinates of barcode detection.

Properties

Name Type Required Restrictions Description
points [Points]¦null false none none

DocumentImageColorStatus

"NOT_AVAILABLE"

Document image color status

Properties

Name Type Required Restrictions Description
Document image color status string false none The color status determined from scanned image.

Enumerated Values

Property Value
Document image color status NOT_AVAILABLE
Document image color status BLACK_AND_WHITE
Document image color status COLOR

DriverLicenseDetailedInfo

{
  "restrictions": "string",
  "endorsements": "string",
  "vehicleClass": "string",
  "conditions": "string",
  "vehicleClassesInfo": [
    {
      "vehicleClass": "string",
      "licenceType": "string",
      "effectiveDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      },
      "expiryDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "originalString": "string"
      }
    }
  ]
}

The driver license detailed info.

Properties

Name Type Required Restrictions Description
restrictions string¦null false none The restrictions to driving privileges for the United States driver license owner.
endorsements string¦null false none The additional privileges granted to the United States driver license owner.
vehicleClass string¦null false none The type of vehicle the driver license owner has privilege to drive.
conditions string¦null false none The driver license conditions.
vehicleClassesInfo [VehicleClassInfo]¦null false none The additional information on vehicle class.

HealthCheckType

"LIVENESS"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous LIVENESS
anonymous READINESS

HealthResult

{
  "name": "string",
  "status": {
    "name": "string",
    "description": "string",
    "operational": true,
    "severity": 0
  },
  "details": {}
}

Properties

Name Type Required Restrictions Description
name string false none none
status HealthStatus false none none
details Object false none none

HealthStatus

{
  "name": "string",
  "description": "string",
  "operational": true,
  "severity": 0
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none
operational boolean true none none
severity integer(int32) true none none

IdBarcodeDocumentType

"NONE"

IdBarcode document type

Properties

Name Type Required Restrictions Description
IdBarcode document type string false none The document type deduced from the recognized barcode.

Enumerated Values

Property Value
IdBarcode document type NONE
IdBarcode document type AAMVA_COMPLIANT
IdBarcode document type ARGENTINA_ID
IdBarcode document type ARGENTINA_ALIEN_ID
IdBarcode document type ARGENTINA_DL
IdBarcode document type COLOMBIA_ID
IdBarcode document type COLOMBIA_DL
IdBarcode document type NIGERIA_VOTER_ID
IdBarcode document type NIGERIA_DL
IdBarcode document type PANAMA_ID
IdBarcode document type SOUTH_AFRICA_ID

IdBarcodeEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "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"
      }
    ],
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "originalString": "string"
    },
    "recognitionStatus": "EMPTY",
    "isBelowAgeLimit": true,
    "age": 0
  }
}

Properties

Name Type Required Restrictions Description
traceId string¦null false none none
executionId string true none none
finishTime string(date-time) true none UTC time after recognition finished.
startTime string(date-time) true none UTC time before recognition started.
data IdBarcodeRecognizerOutput true none none

IdBarcodeRecognizerOutput

{
  "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"
    }
  ],
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "recognitionStatus": "EMPTY",
  "isBelowAgeLimit": true,
  "age": 0
}

Properties

Name Type Required Restrictions Description
documentType any false none none

allOf

Name Type Required Restrictions Description
» anonymous IdBarcodeDocumentType false none The document type deduced from the recognized barcode.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
rawDataBase64 string¦null false none The raw bytes contained inside barcode.
stringData string¦null false none String representation of data inside barcode.
firstName string¦null false none The first name of the document owner.
lastName string¦null false none The last name of the document owner.
middleName string¦null false none The middle name of the document owner.
fullName string¦null false none The full name of the document owner.
additionalNameInformation string¦null false none The additional name information of the document owner.
address string¦null false none The address of the document owner.
placeOfBirth string¦null false none The place of birth of the document owner.
nationality string¦null false none The nationality of the document owner.
race string¦null false none The race of the document owner.
religion string¦null false none The religion of the document owner.
profession string¦null false none The profession of the document owner.
maritalStatus string¦null false none The marital status of the document owner.
residentialStatus string¦null false none The residential status of the document owner.
employer string¦null false none The employer of the document owner.
sex string¦null false none The sex of the document owner.
dateOfIssue any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentNumber string¦null false none The document number.
personalIdNumber string¦null false none The personal identification number.
documentAdditionalNumber string¦null false none The additional number of the document.
issuingAuthority string¦null false none The issuing authority of the document.
restrictions string¦null false none The restrictions to driving privileges for the driver license owner.
endorsements string¦null false none The additional privileges granted to the driver license owner.
vehicleClass string¦null false none The type of vehicle the driver license owner has privilege to drive.
street string¦null false none The street address portion of the document owner.
postalCode string¦null false none The postal code address portion of the document owner.
city string¦null false none The city address portion of the document owner.
jurisdiction string¦null false none The jurisdiction code address portion of the document owner.
extendedElements [BarcodeElement]¦null false none Document specific extended elements that contain all barcode fields in their original form.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
recognitionStatus ResultState true none Possible states of the Recognizer's result.
isBelowAgeLimit boolean¦null 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)¦null false none The calculated age of the document owner.

IdBarcodeRequest

{
  "image": {
    "imageUrl": "string",
    "imageBase64": "string"
  },
  "inputString": "string",
  "ageLimit": 0,
  "traceId": "string"
}

Request body for Id Barcode recognition.

Properties

Name Type Required Restrictions Description
image any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageSource false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
inputString string¦null false none Barcode string. Image parameter takes precedence if image and imageString are defined.
ageLimit integer(int32)¦null false none Defines the age limit for age verification.
traceId string¦null false none none

ImageAnalysisDetectionStatus

"NOT_AVAILABLE"

Image analysis detection status

Properties

Name Type Required Restrictions Description
Image analysis detection status string false none Detection status determined from the scanned image.

Enumerated Values

Property Value
Image analysis detection status NOT_AVAILABLE
Image analysis detection status NOT_DETECTED
Image analysis detection status DETECTED

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¦null false none Whether the image is blurred.
documentImageColorStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous DocumentImageColorStatus false none The color status determined from scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentImageMoireStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisDetectionStatus false none Detection status determined from the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
faceDetectionStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisDetectionStatus false none Detection status determined from the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
mrzDetectionStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisDetectionStatus false none Detection status determined from the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
barcodeDetectionStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous ImageAnalysisDetectionStatus false none Detection status determined from the scanned image.

and

Name Type Required Restrictions Description
» anonymous any false none none

ImageSource

{
  "imageUrl": "string",
  "imageBase64": "string"
}

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

Properties

Name Type Required Restrictions Description
imageUrl string¦null false none Url string of the image.
imageBase64 string¦null false none Base64 string of the image.

MrtdDocumentType

"UNKNOWN"

Mrtd document type

Properties

Name Type Required Restrictions Description
Mrtd document type string false none Possible types of Machine Readable Travel Documents (MRTDs).

Enumerated Values

Property Value
Mrtd document type UNKNOWN
Mrtd document type IDENTITY_CARD
Mrtd document type PASSPORT
Mrtd document type VISA
Mrtd document type GREEN_CARD
Mrtd document type MALAYSIAN_PASS_IMM13P
Mrtd document type DRIVER_LICENSE
Mrtd document type INTERNATIONAL_TRAVEL_DOCUMENT
Mrtd document type BORDER_CROSSING_CARD

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"
}

The data extracted from the machine readable zone.

Properties

Name Type Required Restrictions Description
rawMrzString string¦null 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¦null 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¦null 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¦null 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¦null 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¦null 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¦null 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¦null 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¦null false none The primary indentifier. If there is more than one component, they are separated with space.
secondaryId string¦null false none The secondary identifier. If there is more than one component, they are separated with space.
alienNumber string¦null 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¦null 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¦null 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¦null false none True if all check digits inside MRZ are correct, false otherwise.
mrzParsed boolean¦null false none True if Machine Readable Zone has been parsed, false otherwise.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
documentType any false none none

allOf

Name Type Required Restrictions Description
» anonymous MrtdDocumentType false none Possible types of Machine Readable Travel Documents (MRTDs).

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
issuerName string¦null false none Returns full issuer name that is expanded from the three-letter or two-letter code which indicate the issuing State.
nationalityName string¦null false none Returns full nationality of the holder, which is expanded from the three-letter or two-letter nationality code.

Object

{}

Properties

None

Points

{
  "x": 0,
  "y": 0
}

Properties

Name Type Required Restrictions Description
x integer(int32)¦null false none none
y integer(int32)¦null false none none

ProcessingStatus

"SUCCESS"

Processing status

Properties

Name Type Required Restrictions Description
Processing status string false none Detailed information about the recognition process.

Enumerated Values

Property Value
Processing status SUCCESS
Processing status DETECTION_FAILED
Processing status IMAGE_PREPROCESSING_FAILED
Processing status STABILITY_TEST_FAILED
Processing status SCANNING_WRONG_SIDE
Processing status FIELD_IDENTIFICATION_FAILED
Processing status MANDATORY_FIELD_MISSING
Processing status INVALID_CHARACTERS_FOUND
Processing status IMAGE_RETURN_FAILED
Processing status BARCODE_RECOGNITION_FAILED
Processing status MRZ_PARSING_FAILED
Processing status CLASS_FILTERED
Processing status UNSUPPORTED_CLASS
Processing status UNSUPPORTED_BY_LICENSE
Processing status AWAITING_OTHER_SIDE
Processing status NOT_SCANNED

RecognitionMode

"NONE"

Recognition mode

Properties

Name Type Required Restrictions Description
Recognition mode string false none Recognition mode used to scan current document.

Enumerated Values

Property Value
Recognition mode NONE
Recognition mode MRZ_ID
Recognition mode MRZ_VISA
Recognition mode MRZ_PASSPORT
Recognition mode PHOTO_ID
Recognition mode FULL_RECOGNITION
Recognition mode BARCODE_ID

Region

"REGION_NONE"

Region

Properties

Name Type Required Restrictions Description
Region string false none Document region.

Enumerated Values

Property Value
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
Region REGION_AGUASCALIENTES
Region REGION_BAJA_CALIFORNIA_SUR
Region REGION_CAMPECHE
Region REGION_COLIMA
Region REGION_QUINTANA_ROO_BENITO_JUAREZ
Region REGION_QUINTANA_ROO
Region REGION_QUINTANA_ROO_SOLIDARIDAD
Region REGION_TLAXCALA

ResultState

"EMPTY"

Result state

Properties

Name Type Required Restrictions Description
Result state string false none Possible states of the Recognizer's result.

Enumerated Values

Property Value
Result state EMPTY
Result state UNCERTAIN
Result state VALID
Result state STAGE_VALID

Type

"TYPE_NONE"

Type

Properties

Name Type Required Restrictions Description
Type string false none Document type.

Enumerated Values

Property Value
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
Type TYPE_CITIZENSHIP_CERTIFICATE
Type TYPE_MY_NUMBER_CARD

VIZResult

{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "additionalNameInformation": "string",
  "localizedName": "string",
  "address": "string",
  "additionalAddressInformation": "string",
  "additionalOptionalAddressInformation": "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",
  "fathersName": "string",
  "mothersName": "string",
  "driverLicenseDetailedInfo": {
    "restrictions": "string",
    "endorsements": "string",
    "vehicleClass": "string",
    "conditions": "string",
    "vehicleClassesInfo": [
      {
        "vehicleClass": "string",
        "licenceType": "string",
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "originalString": "string"
        }
      }
    ]
  }
}

The data extracted from the visual inspection zone.

Properties

Name Type Required Restrictions Description
firstName string¦null false none The first name of the document owner.
lastName string¦null false none The last name of the document owner.
fullName string¦null false none The full name of the document owner.
additionalNameInformation string¦null false none The additional name information of the document owner.
localizedName string¦null false none The localized name of the document.
address string¦null false none The address of the document owner.
additionalAddressInformation string¦null false none The additional address information of the document owner.
additionalOptionalAddressInformation string¦null false none The one more additional address information of the document owner.
placeOfBirth string¦null false none The place of birth of the document owner.
nationality string¦null false none The nationality of the documet owner.
race string¦null false none The race of the document owner.
religion string¦null false none The religion of the document owner.
profession string¦null false none The profession of the document owner.
maritalStatus string¦null false none The marital status of the document owner.
residentialStatus string¦null false none The residential stauts of the document owner.
employer string¦null false none The employer of the document owner.
sex string¦null false none The sex of the document owner.
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfIssue any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiry any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
dateOfExpiryPermanent boolean¦null false none Determines if date of expiry is permanent.
documentNumber string¦null false none The document number.
personalIdNumber string¦null false none The personal identification number.
documentAdditionalNumber string¦null false none The additional number of the document.
additionalPersonalIdNumber string¦null false none The additional personal identification number.
documentOptionalAdditionalNumber string¦null false none The one more additional number of the document.
issuingAuthority string¦null false none The issuing authority of the document.
fathersName string¦null false none The fathers name of the document owner.
mothersName string¦null false none The mothers name of the document owner.
driverLicenseDetailedInfo any false none none

allOf

Name Type Required Restrictions Description
» anonymous DriverLicenseDetailedInfo false none The driver license detailed info.

and

Name Type Required Restrictions Description
» anonymous any false none none

VehicleClassInfo

{
  "vehicleClass": "string",
  "licenceType": "string",
  "effectiveDate": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  },
  "expiryDate": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "originalString": "string"
  }
}

The additional information on vehicle class.

Properties

Name Type Required Restrictions Description
vehicleClass string¦null false none The type of vehicle the driver license owner has privilege to drive.
licenceType string¦null false none The type of driver licence.
effectiveDate any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

continued

Name Type Required Restrictions Description
expiryDate any false none none

allOf

Name Type Required Restrictions Description
» anonymous DateResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none none

Release Notes

2.6.2

Improvements for existing features:

2.6.1

Improvements for existing features:

2.6.0.

We've added new documents to our list of supported documents

Back side support added:

No longer BETA:

Changes to BlinkID(Combined) Recognizer

Removed recognizers

Changes to IDBarcodeRecognizer

Improvements

2.5.1

Bug fixes:

2.5.0

Newly added versions of documents for already supported documents

We’ve added 24 new documents to our list:

Changes to BlinkID(Combined) Recognizer

Improvements

Changes to USDLRecognizer

Changes to IDBarcodeRecognizer

Changes to MRTDRecognizer

2.4.0

New feature

2.3.0

Back side support added:

Changes to BlinkID(Combined) Recognizer

Improvements

Changes to BarcodeRecognizer

Changes to MRTDRecognizer

2.2.2

Improvements for existing features:

2.2.1

Bug fixes:

2.2.0

We’ve added 61 new documents to our supported document list

Back side support added:

No longer BETA:

Changes to BlinkID(Combined) Recognizer

Changes to BlinkCardRecognizer

Improvements

Anonymization

2.1.1

Improvements

2.1.0

We've added 15 new documents to our list of supported documents:

Back side support added:

No longer BETA:

Changes to BlinkID(Combined) Recognizer

Improvements

Anonymization

2.0.0

New features and improvements

1.36.1

Bug fixes:

1.36.0

We've added 15 new documents to our list of supported documents:

Back side support added:

No longer BETA:

Changes to BlinkID(Combined) Recognizer

Improvements

Anonymization

1.35.1

Bug fixes:

1.35.0

New documents added to BlinkID(Combined)Recognizer:

Improvements for existing features

Bug fixes:

1.34.1

Bug fixes:

1.34.0

Newly supported identity documents:

1.33.2

Improvements for existing features:

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

1.33.1

Improvements for existing features:

We changed the default value for WORKER_TIMEOUT_MS parameter to 30000.

1.33.0

New additions to our supported documents list

New features and updates to the BlinkId(Combined)Recognizer

Fixes

Other features and updates

1.32.1

Bug fixes

We fixed an issue where traceId wasn't shown in logs for BLINK_ID_COMBINED recognizer

Improvements for existing features:

We changed the default value for allowBlurFilter parameter to false. Now blurred documents wont 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

Other features and updates

Fixes

1.31.1

Bug fixes

1.31.0

Improvements to existing features:

Minor API Changes

As you will probably notice we skipped one version, it's not a mistake. The version 1.30.0 was our internal release.

1.29.0

New features

Bug fixes

1.28.1

Bug fixes

1.28.0

New features

1.27.0

Improvements for existing features:

1.26.0

New features:

Improvements for existing features:

1.25.0

New features

1.24.1

Bug fixes

1.24.0

New features:

Improvements for existing features:

1.23.0

New Features

1.22.0

New features

1.21.0

Security Updates

New Features

Supported Documents

1.20.1

New features

Improvements for existing features

1.19.0

New features

1.18.1

Internal improvements

1.18.0

New features

Improvements for existing features

Internal improvements

1.17.1

Improvements

1.17.0

New features

Improvements

Notes

Tutorials

1.16.1

New features

Improvements

1.15.0

New features

Improvements for existing features

1.14.0

New features

Notes

Examples
Image file size Image type Image resolution Megapixels Memory consumption
0.8MB JPEG 1024x1365 1.4 127MB
2.9MB JPEG 2048x2731 5.59 182MB
3.3MB JPEG 4000x3000 12 298MB
8.2MB JPEG 4096x5461 22.4 451MB
19.5MB JPEG 8192x10923 89.5 960MB
72MB JPEG 16384x21845 358 3.5GB

1.13.0

New features

Bug fixes

1.12.0

New features

Existing features update

API change

1.11.2

1.11.1

1.11.0

1.10.0

1.9.0

1.8.0

1.7.1

1.7.0

1.6.0

1.5.0

NOTE: Docker secrets are only available to swarm services, not to standalone containers. Docker Compose template is available on GitHub as docker-compose.swarm.yml. How to start application on the Swarm node please follow this steps.

1.4.1

1.4.0

1.3.3

1.3.2

1.3.1

1.3.0

1.2.0

1.1.0

1.0.2

1.0.1

1.0.0