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 3.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-multi-side
Scanning the front side of supported documents or MRZ on passports, visas and other documents. /blinkid-single-side
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.11 GNU Lesser General Public License
com.amazonaws:aws-java-sdk-bom 1.12.267
com.azure:azure-sdk-bom 1.1.1
com.fasterxml.jackson.core:jackson-core https://github.com/FasterXML/jackson-core 2.13.2 The Apache Software License, Version 2.0
com.google.code.gson:gson 2.8.5 Apache 2.0
io.micrometer:micrometer-core https://github.com/micrometer-metrics/micrometer 1.9.0 The Apache Software License, Version 2.0
io.micrometer:micrometer-registry-prometheus https://github.com/micrometer-metrics/micrometer 1.9.0 The Apache Software License, Version 2.0
io.micronaut.aws:micronaut-aws-bom 3.5.3
io.micronaut.azure:micronaut-azure-bom 3.2.3
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.email:micronaut-email-bom 1.2.3
io.micronaut.flyway:micronaut-flyway-bom 5.3.0
io.micronaut.gcp:micronaut-gcp-bom 4.2.1
io.micronaut.grpc:micronaut-grpc-bom 3.3.1
io.micronaut.jaxrs:micronaut-jaxrs-bom 3.3.0
io.micronaut.kafka:micronaut-kafka-bom 4.3.1
io.micronaut.kotlin:micronaut-kotlin-runtime https://micronaut.io 3.2.2 The Apache Software License, Version 2.0
io.micronaut.kubernetes:micronaut-kubernetes-bom 3.4.0
io.micronaut.microstream:micronaut-microstream-bom 1.0.0-M1
io.micronaut.mongodb:micronaut-mongo-bom 4.2.0
io.micronaut.mqtt:micronaut-mqtt-bom 2.2.0
io.micronaut.picocli:micronaut-picocli-bom 4.2.1
io.micronaut.problem:micronaut-problem-json-bom 2.3.1
io.micronaut.reactor:micronaut-reactor https://micronaut.io 2.2.3 The Apache Software License, Version 2.0
io.micronaut.reactor:micronaut-reactor-bom 2.2.3
io.micronaut.redis:micronaut-redis-bom 5.2.0
io.micronaut.rxjava2:micronaut-rxjava2-bom 1.2.2
io.micronaut.rxjava3:micronaut-rxjava3-bom 2.2.1
io.micronaut.security:micronaut-security https://micronaut.io 3.6.3 The Apache Software License, Version 2.0
io.micronaut.security:micronaut-security-annotations https://micronaut.io 3.6.3 The Apache Software License, Version 2.0
io.micronaut.security:micronaut-security-bom 3.6.3
io.micronaut.serde:micronaut-serde-bom 1.1.0
io.micronaut.servlet:micronaut-servlet-bom 3.2.3
io.micronaut.sql:micronaut-sql-bom 4.4.1
io.micronaut.tracing:micronaut-tracing-bom 4.1.1
io.micronaut.views:micronaut-views-bom 3.4.0
io.micronaut:micronaut-core https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-http https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-http-client-core https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-jackson-core https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-json-core https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-management https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-runtime https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.micronaut:micronaut-validation https://micronaut.io 3.5.4 The Apache Software License, Version 2.0
io.projectreactor:reactor-core https://github.com/reactor/reactor-core 3.4.21 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.jdbi:jdbi3-bom 3.28.0
org.jetbrains.kotlinx:kotlinx-coroutines-core 1.6.0
org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm https://github.com/Kotlin/kotlinx.coroutines 1.6.0 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.36 MIT License
org.yaml:snakeyaml https://bitbucket.org/snakeyaml/snakeyaml 1.30 Apache License, Version 2.0
software.amazon.awssdk:bom 2.17.238

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
LOG_ENABLE_CUSTOMIZATION Whether to allow logger customizations (Guard for LOG_ENABLE_CONSOLE_APPENDER, LOG_ENABLE_FILE_APPENDER, LOG_PATTERN and LOGGER_MAP). 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
NON_PROXY_HOSTS The list of hosts that should be reached directly, bypassing the proxy. This is a list of patterns separated by | . String
TRUST_STORE Trust store path. String
TRUST_STORE_PASSWORD Trust store password. Needed only if a trust store is password protected. String
SSL_ENABLED Whether SSL is enabled. Boolean false
SSL_KEY_STORE_PATH SSL key store path. String
SSL_KEY_STORE_PASSWORD SSL key store password. String
SSL_KEY_STORE_TYPE Type of keystore. String
SSL_KEY_STORE_PROVIDER Name of the key store provider. String
SSL_KEY_PASSWORD SSL key password. String
SSL_KEY_ALIAS SSL key alias. String
JAVA_OPTS Runtime Java options for GraalVM native image. String
HEALTH_CUSTOM_URL Custom health endpoint. String

Docker compose

Minimal docker compose sample can be found here

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

It is strongly recommended to configure Cross-origin resource sharing (CORS) policy control in order to minimize security risks by using the following environment variables ALLOW_CORS, ALLOWED_METHODS, ALLOWED_ORIGINS. The second recommendation is to use https instead of http for external service interaction, for example, setting IMAGE_URL_PROTOCOLS_ALLOWED only to https (which is the default setting). Finally, it is recommended to implement API rate limiting based on the number of requests made to the specific API endpoint based on the request per time or IP address for example by using load balancer, proxy, horizontal scaling policy, etc.

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.

Default

healthProxy

Code samples

# You can also use wget
curl -X GET /${microblink.health.custom.url} \
  -H 'Accept: application/json'


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

r = requests.get('/${microblink.health.custom.url}', headers = headers)

print(r.json())



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

fetch('/${microblink.health.custom.url}',
{
  method: 'GET',

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


URL obj = new URL("/${microblink.health.custom.url}");
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 = "/${microblink.health.custom.url}";
      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 /${microblink.health.custom.url}

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK healthProxy 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¦null true none none
»» operational boolean¦null true none none
»» severity integer(int32)¦null true none none
» details Object false none none

Recognition endpoints

Barcode

Code samples

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


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

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',
  'X-ClientCustomerId':'string'
};

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
X-ClientCustomerId header string false none
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 none 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",
    "fallbackAnonymization": false
  },
  "allowBlurFilter": true,
  "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"",
    ""fallbackAnonymization"": false
  },
  ""allowBlurFilter"": true,
  ""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",
    "fallbackAnonymization": false
  },
  "allowBlurFilter": true,
  "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,
      "filledByDomainKnowledge": 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 none BlinkCardEndpointResponse
400 Bad Request none DefaultResponse
403 Forbidden none DefaultResponse
500 Internal Server Error none DefaultResponse

BlinkIdMultiSide

Code samples

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


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

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

print(r.json())


const inputBody = '{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": true,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "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',
  'X-ClientCustomerId':'string'
};

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


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

      string json = @"{
  ""returnFullDocumentImage"": false,
  ""returnFaceImage"": false,
  ""returnSignatureImage"": false,
  ""allowBlurFilter"": true,
  ""allowUnparsedMrzResults"": false,
  ""allowUnverifiedMrzResults"": true,
  ""skipUnsupportedBack"": false,
  ""validateResultCharacters"": true,
  ""anonymizationMode"": ""FULL_RESULT"",
  ""imageFront"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""imageBack"": {
    ""imageUrl"": ""string"",
    ""imageBase64"": ""string""
  },
  ""ageLimit"": 0,
  ""scanCroppedDocumentImage"": false,
  ""maxAllowedMismatchesPerField"": 0,
  ""allowUncertainFrontSideScan"": true,
  ""traceId"": ""string""
}";
      BlinkIdMultiSideRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(BlinkIdMultiSideRequest 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(BlinkIdMultiSideRequest 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-multi-side

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

Body parameter

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": true,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "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
X-ClientCustomerId header string false none
body body BlinkIdMultiSideRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          }
        }
      ]
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dataMatchResult": {
      "dateOfBirth": "NOT_PERFORMED",
      "dateOfExpiry": "NOT_PERFORMED",
      "documentNumber": "NOT_PERFORMED",
      "documentAdditionalNumber": "NOT_PERFORMED",
      "documentOptionalAdditionalNumber": "NOT_PERFORMED",
      "personalIdNumber": "NOT_PERFORMED",
      "dataMatchResult": "NOT_PERFORMED"
    },
    "dateOfExpiryPermanent": true,
    "scanningFirstSideDone": true,
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "frontViz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            }
          }
        ]
      }
    },
    "backViz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": 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,
              "filledByDomainKnowledge": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": 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",
      "cardOrientation": "HORIZONTAL"
    },
    "backImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE",
      "cardOrientation": "HORIZONTAL"
    },
    "processingStatus": "SUCCESS",
    "frontProcessingStatus": "SUCCESS",
    "backProcessingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "frontAdditionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "backAdditionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "belowAgeLimit": true,
    "age": 0
  }
}

Responses

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

BlinkIdSingleSide

Code samples

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


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

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

print(r.json())


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

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


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

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


    }

    /// Performs a POST Request
    public async Task PostAsync(BlinkIdSingleSideRequest 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(BlinkIdSingleSideRequest 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-single-side

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

Body parameter

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

Parameters

Name In Type Required Description
X-ClientCustomerId header string false none
body body BlinkIdSingleSideRequest true none

Example responses

200 Response

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          }
        }
      ]
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "viz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": 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,
              "filledByDomainKnowledge": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": 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",
      "cardOrientation": "HORIZONTAL"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "belowAgeLimit": true,
    "age": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none BlinkIdSingleSideEndpointResponse
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' \
  -H 'X-ClientCustomerId: string'


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

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',
  'X-ClientCustomerId':'string'
};

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
X-ClientCustomerId header string false none
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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": 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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "recognitionStatus": "EMPTY",
    "belowAgeLimit": true,
    "age": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none 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¦null true none none
»» operational boolean¦null true none none
»» severity integer(int32)¦null 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¦null true none none
»» operational boolean¦null true none none
»» severity integer(int32)¦null 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

AdditionalProcessingInfo

{
  "missingMandatoryFields": [
    "ADDITIONAL_ADDRESS_INFORMATION"
  ],
  "invalidCharacterFields": [
    "ADDITIONAL_ADDRESS_INFORMATION"
  ],
  "extraPresentFields": [
    "ADDITIONAL_ADDRESS_INFORMATION"
  ]
}

The additional details about the processing info.

Properties

Name Type Required Restrictions Description
missingMandatoryFields [FieldType]¦null false none List of fields that were expected on the document but were missing.
invalidCharacterFields [FieldType]¦null false none List of fields that contained characters which were not expected in that field.
extraPresentFields [FieldType]¦null false none List of fields that weren't expected on the document but were present.

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",
  "fallbackAnonymization": false
}

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 CardNumberAnonymizationSettings false none Defines the parameters of card number anonymization.

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 AnonymizationMode false none Defines the mode of card number prefix anonymization. Default 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 AnonymizationMode false none Defines the mode of CVV anonymization. Default 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 AnonymizationMode false none Defines the mode of IBAN anonymization. Default 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 AnonymizationMode false none Defines the mode of owner anonymization. Default NONE

continued

Name Type Required Restrictions Description
fallbackAnonymization boolean¦null false none If true, anonymization is applied on all fields of the image if extraction is uncertain. Default FALSE

BarcodeDriverLicenseDetailedInfo

{
  "restrictions": "string",
  "endorsements": "string",
  "vehicleClass": "string",
  "conditions": "string",
  "vehicleClassesInfo": [
    {
      "vehicleClass": "string",
      "licenceType": "string",
      "effectiveDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "expiryDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": 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 [BarcodeVehicleClassInfo]¦null false none The additional information on vehicle class.

BarcodeElement

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

Properties

Name Type Required Restrictions Description
key BarcodeElementKey¦null false none Additional fields present in the barcode.
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"
  }
}

Response for Barcode.

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 BarcodeType¦null false none Type of barcode.
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 DetectionPoints¦null false none Points array with coordinates of barcode detection.
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 ImageSource¦null true none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
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,
    "filledByDomainKnowledge": true,
    "originalString": "string"
  },
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": "string"
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": 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,
          "filledByDomainKnowledge": true,
          "originalString": "string"
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "filledByDomainKnowledge": 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 Date¦null false none none
dateOfIssue Date¦null false none none
dateOfExpiry Date¦null false none none
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 AddressDetailedInfo¦null false none The details about the address.
driverLicenseDetailedInfo BarcodeDriverLicenseDetailedInfo¦null false none The driver license detailed info.
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

BarcodeVehicleClassInfo

{
  "vehicleClass": "string",
  "licenceType": "string",
  "effectiveDate": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": "string"
  },
  "expiryDate": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": 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 Date false none none

and

Name Type Required Restrictions Description
» anonymous any false none The date since licence is effective

continued

Name Type Required Restrictions Description
expiryDate any false none none

allOf

Name Type Required Restrictions Description
» anonymous Date false none none

and

Name Type Required Restrictions Description
» anonymous any false none The date of expiry of licence.

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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "owner": "string",
    "firstSideFullDocumentImage": "string",
    "secondSideFullDocumentImage": "string",
    "firstSideBlurred": true,
    "secondSideBlurred": true,
    "processingStatus": "SUCCESS",
    "scanningFirstSideDone": true,
    "recognitionStatus": "EMPTY"
  }
}

Response for BlinkCard.

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,
    "filledByDomainKnowledge": 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 Date¦null false none none
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",
    "fallbackAnonymization": false
  },
  "allowBlurFilter": true,
  "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 AnonymizationSettings¦null false none Whether sensitive data should be redacted from the result.
allowBlurFilter boolean¦null false none Defines whether blurred frames filtering is allowed. Default TRUE
cardNumberSide ImageSource¦null true none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
otherSide ImageSource¦null false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
traceId string¦null false none none

BlinkIdMultiSideEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          }
        }
      ]
    },
    "fullDocumentFrontImageBase64": "string",
    "fullDocumentBackImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dataMatchResult": {
      "dateOfBirth": "NOT_PERFORMED",
      "dateOfExpiry": "NOT_PERFORMED",
      "documentNumber": "NOT_PERFORMED",
      "documentAdditionalNumber": "NOT_PERFORMED",
      "documentOptionalAdditionalNumber": "NOT_PERFORMED",
      "personalIdNumber": "NOT_PERFORMED",
      "dataMatchResult": "NOT_PERFORMED"
    },
    "dateOfExpiryPermanent": true,
    "scanningFirstSideDone": true,
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "frontViz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            }
          }
        ]
      }
    },
    "backViz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": 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,
              "filledByDomainKnowledge": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": 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",
      "cardOrientation": "HORIZONTAL"
    },
    "backImageAnalysisResult": {
      "blurred": true,
      "documentImageColorStatus": "NOT_AVAILABLE",
      "documentImageMoireStatus": "NOT_AVAILABLE",
      "faceDetectionStatus": "NOT_AVAILABLE",
      "mrzDetectionStatus": "NOT_AVAILABLE",
      "barcodeDetectionStatus": "NOT_AVAILABLE",
      "cardOrientation": "HORIZONTAL"
    },
    "processingStatus": "SUCCESS",
    "frontProcessingStatus": "SUCCESS",
    "backProcessingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "frontAdditionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "backAdditionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "belowAgeLimit": true,
    "age": 0
  }
}

Response for BlinkIdMultiSide.

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 BlinkIdMultiSideRecognizerOutput true none none

BlinkIdMultiSideRecognizerOutput

{
  "firstName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "lastName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "fullName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "address": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "documentNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "sex": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "driverLicenseDetailedInfo": {
    "restrictions": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "endorsements": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "vehicleClass": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "conditions": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "vehicleClassesInfo": [
      {
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "licenceType": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "filledByDomainKnowledge": true,
          "originalString": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          }
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "filledByDomainKnowledge": true,
          "originalString": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          }
        }
      }
    ]
  },
  "fullDocumentFrontImageBase64": "string",
  "fullDocumentBackImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "additionalAddressInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "additionalOptionalAddressInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "placeOfBirth": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "nationality": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "race": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "religion": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "profession": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "maritalStatus": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "residentialStatus": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "employer": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "personalIdNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "documentAdditionalNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "documentOptionalAdditionalNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "issuingAuthority": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "documentType": "UNKNOWN",
    "issuerName": "string",
    "nationalityName": "string"
  },
  "localizedName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "dataMatchResult": {
    "dateOfBirth": "NOT_PERFORMED",
    "dateOfExpiry": "NOT_PERFORMED",
    "documentNumber": "NOT_PERFORMED",
    "documentAdditionalNumber": "NOT_PERFORMED",
    "documentOptionalAdditionalNumber": "NOT_PERFORMED",
    "personalIdNumber": "NOT_PERFORMED",
    "dataMatchResult": "NOT_PERFORMED"
  },
  "dateOfExpiryPermanent": true,
  "scanningFirstSideDone": true,
  "additionalPersonalIdNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "frontViz": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          }
        }
      ]
    }
  },
  "backViz": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": 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,
            "filledByDomainKnowledge": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": 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",
    "cardOrientation": "HORIZONTAL"
  },
  "backImageAnalysisResult": {
    "blurred": true,
    "documentImageColorStatus": "NOT_AVAILABLE",
    "documentImageMoireStatus": "NOT_AVAILABLE",
    "faceDetectionStatus": "NOT_AVAILABLE",
    "mrzDetectionStatus": "NOT_AVAILABLE",
    "barcodeDetectionStatus": "NOT_AVAILABLE",
    "cardOrientation": "HORIZONTAL"
  },
  "processingStatus": "SUCCESS",
  "frontProcessingStatus": "SUCCESS",
  "backProcessingStatus": "SUCCESS",
  "recognitionMode": "NONE",
  "signatureImageBase64": "string",
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "classInfo": {
    "country": "COUNTRY_NONE",
    "region": "REGION_NONE",
    "type": "TYPE_NONE",
    "countryName": "string",
    "isoAlpha3CountryCode": "string",
    "isoAlpha2CountryCode": "string",
    "isoNumericCountryCode": "string"
  },
  "recognitionStatus": "EMPTY",
  "fathersName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "mothersName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "frontAdditionalProcessingInfo": {
    "missingMandatoryFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "invalidCharacterFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "extraPresentFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ]
  },
  "backAdditionalProcessingInfo": {
    "missingMandatoryFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "invalidCharacterFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "extraPresentFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ]
  },
  "belowAgeLimit": true,
  "age": 0
}

Properties

Name Type Required Restrictions Description
firstName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The first name of the document owner.

continued

Name Type Required Restrictions Description
lastName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The last name of the document owner.

continued

Name Type Required Restrictions Description
fullName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The last name of the document owner.

continued

Name Type Required Restrictions Description
address any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The address of the document owner.

continued

Name Type Required Restrictions Description
dateOfIssue DateResult¦null false none none
dateOfExpiry DateResult¦null false none none
documentNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The document number.

continued

Name Type Required Restrictions Description
sex any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The sex of the document owner.

continued

Name Type Required Restrictions Description
driverLicenseDetailedInfo DriverLicenseDetailedInfo¦null false none The driver license detailed info.
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 any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional name information of the document owner.

continued

Name Type Required Restrictions Description
additionalAddressInformation any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional address information of the document owner.

continued

Name Type Required Restrictions Description
additionalOptionalAddressInformation any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The one more additional address information of the document owner.

continued

Name Type Required Restrictions Description
placeOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The place of birth of the document owner.

continued

Name Type Required Restrictions Description
nationality any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The nationality of the documet owner.

continued

Name Type Required Restrictions Description
race any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The race of the document owner.

continued

Name Type Required Restrictions Description
religion any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The religion of the document owner.

continued

Name Type Required Restrictions Description
profession any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The profession of the document owner.

continued

Name Type Required Restrictions Description
maritalStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The marital status of the document owner.

continued

Name Type Required Restrictions Description
residentialStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The residential stauts of the document owner.

continued

Name Type Required Restrictions Description
employer any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The employer of the document owner.

continued

Name Type Required Restrictions Description
personalIdNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The personal identification number.

continued

Name Type Required Restrictions Description
documentAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional number of the document.

continued

Name Type Required Restrictions Description
documentOptionalAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The one more additional number of the document.

continued

Name Type Required Restrictions Description
issuingAuthority any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The issuing authority of the document.

continued

Name Type Required Restrictions Description
mrzData MrzResult¦null false none The data extracted from the machine readable zone.
localizedName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The localized name of the document.

continued

Name Type Required Restrictions Description
dataMatchResult DataMatchResult¦null false none Result of data match check.
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 any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional personal identification number.

continued

Name Type Required Restrictions Description
frontViz VIZResult¦null false none The data extracted from the visual inspection zone.
backViz VIZResult¦null false none The data extracted from the visual inspection zone.
barcode BarcodeResult¦null false none The data extracted from the barcode.
frontImageAnalysisResult ImageAnalysisResult¦null false none Various information obtained by analysing the scanned image.
backImageAnalysisResult ImageAnalysisResult¦null false none Various information obtained by analysing the scanned image.
processingStatus ProcessingStatus¦null false none Detailed information about the recognition process.
frontProcessingStatus ProcessingStatus¦null false none Detailed information about the recognition process.
backProcessingStatus ProcessingStatus¦null false none Detailed information about the recognition process.
recognitionMode RecognitionMode¦null false none Recognition mode used to scan current document.
signatureImageBase64 string¦null false none The signature image.
dateOfBirth DateResult¦null false none none
classInfo ClassInfo¦null false none The document class information.
recognitionStatus ResultState true none Possible states of the Recognizer's result.
fathersName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The fathers name of the document owner.

continued

Name Type Required Restrictions Description
mothersName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The mothers name of the document owner.

continued

Name Type Required Restrictions Description
frontAdditionalProcessingInfo AdditionalProcessingInfo¦null false none The additional details about the processing info.
backAdditionalProcessingInfo AdditionalProcessingInfo¦null false none The additional details about the processing info.
belowAgeLimit 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.

BlinkIdMultiSideRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": true,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "skipUnsupportedBack": false,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "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 TRUE
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 AnonymizationMode false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT

continued

Name Type Required Restrictions Description
additionalAnonymization [ClassAnonymizationSettings]¦null false none [Redact fields for specific document class. Fields specified by requirements or laws for a specific document will be redacted regardless of this setting. Based on anonymizationMode setting, data will be redacted from the image, the result or both.]
imageFront ImageSource¦null true none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
imageBack ImageSource¦null false none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
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

BlinkIdSingleSideEndpointResponse

{
  "traceId": "string",
  "executionId": "string",
  "finishTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "data": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          }
        }
      ]
    },
    "fullDocumentImageBase64": "string",
    "faceImageBase64": "string",
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "documentType": "UNKNOWN",
      "issuerName": "string",
      "nationalityName": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfExpiryPermanent": true,
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "viz": {
      "firstName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "lastName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fullName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalNameInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "localizedName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "address": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalOptionalAddressInformation": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "placeOfBirth": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "nationality": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "race": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "religion": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "profession": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "maritalStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "residentialStatus": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "employer": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "sex": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "dateOfExpiryPermanent": true,
      "documentNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "personalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "additionalPersonalIdNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "documentOptionalAdditionalNumber": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "issuingAuthority": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "fathersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "mothersName": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "driverLicenseDetailedInfo": {
        "restrictions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "endorsements": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "conditions": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "vehicleClassesInfo": [
          {
            "vehicleClass": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "licenceType": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            },
            "effectiveDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "string"
              }
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": true,
              "originalString": {
                "latin": "string",
                "cyrillic": "string",
                "arabic": "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,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfIssue": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": "string"
      },
      "dateOfExpiry": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": 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,
              "filledByDomainKnowledge": true,
              "originalString": "string"
            },
            "expiryDate": {
              "day": 0,
              "month": 0,
              "year": 0,
              "successfullyParsed": true,
              "filledByDomainKnowledge": 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",
      "cardOrientation": "HORIZONTAL"
    },
    "processingStatus": "SUCCESS",
    "recognitionMode": "NONE",
    "signatureImageBase64": "string",
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "classInfo": {
      "country": "COUNTRY_NONE",
      "region": "REGION_NONE",
      "type": "TYPE_NONE",
      "countryName": "string",
      "isoAlpha3CountryCode": "string",
      "isoAlpha2CountryCode": "string",
      "isoNumericCountryCode": "string"
    },
    "recognitionStatus": "EMPTY",
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalProcessingInfo": {
      "missingMandatoryFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "invalidCharacterFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ],
      "extraPresentFields": [
        "ADDITIONAL_ADDRESS_INFORMATION"
      ]
    },
    "belowAgeLimit": true,
    "age": 0
  }
}

Response for BlinkId.

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 BlinkIdSingleSideRecognizerOutput true none none

BlinkIdSingleSideRecognizerOutput

{
  "firstName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "lastName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "fullName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "address": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "dateOfIssue": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "dateOfExpiry": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "documentNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "sex": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "driverLicenseDetailedInfo": {
    "restrictions": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "endorsements": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "vehicleClass": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "conditions": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "vehicleClassesInfo": [
      {
        "vehicleClass": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "licenceType": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        },
        "effectiveDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "filledByDomainKnowledge": true,
          "originalString": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          }
        },
        "expiryDate": {
          "day": 0,
          "month": 0,
          "year": 0,
          "successfullyParsed": true,
          "filledByDomainKnowledge": true,
          "originalString": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          }
        }
      }
    ]
  },
  "fullDocumentImageBase64": "string",
  "faceImageBase64": "string",
  "additionalNameInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "additionalAddressInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "additionalOptionalAddressInformation": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "placeOfBirth": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "nationality": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "race": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "religion": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "profession": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "maritalStatus": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "residentialStatus": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "employer": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "personalIdNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "documentAdditionalNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "documentOptionalAdditionalNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "issuingAuthority": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "documentType": "UNKNOWN",
    "issuerName": "string",
    "nationalityName": "string"
  },
  "localizedName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "dateOfExpiryPermanent": true,
  "additionalPersonalIdNumber": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "viz": {
    "firstName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "lastName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fullName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalNameInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "localizedName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "address": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalOptionalAddressInformation": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "placeOfBirth": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "nationality": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "race": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "religion": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "profession": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "maritalStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "residentialStatus": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "employer": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "sex": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "dateOfBirth": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      }
    },
    "dateOfExpiryPermanent": true,
    "documentNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "personalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "additionalPersonalIdNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "documentOptionalAdditionalNumber": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "issuingAuthority": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "fathersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "mothersName": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    },
    "driverLicenseDetailedInfo": {
      "restrictions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "endorsements": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "conditions": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "vehicleClassesInfo": [
        {
          "vehicleClass": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "licenceType": {
            "latin": "string",
            "cyrillic": "string",
            "arabic": "string"
          },
          "effectiveDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "string"
            }
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": true,
            "originalString": {
              "latin": "string",
              "cyrillic": "string",
              "arabic": "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,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfIssue": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": true,
      "originalString": "string"
    },
    "dateOfExpiry": {
      "day": 0,
      "month": 0,
      "year": 0,
      "successfullyParsed": true,
      "filledByDomainKnowledge": 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,
            "filledByDomainKnowledge": true,
            "originalString": "string"
          },
          "expiryDate": {
            "day": 0,
            "month": 0,
            "year": 0,
            "successfullyParsed": true,
            "filledByDomainKnowledge": 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",
    "cardOrientation": "HORIZONTAL"
  },
  "processingStatus": "SUCCESS",
  "recognitionMode": "NONE",
  "signatureImageBase64": "string",
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0,
    "successfullyParsed": true,
    "filledByDomainKnowledge": true,
    "originalString": {
      "latin": "string",
      "cyrillic": "string",
      "arabic": "string"
    }
  },
  "classInfo": {
    "country": "COUNTRY_NONE",
    "region": "REGION_NONE",
    "type": "TYPE_NONE",
    "countryName": "string",
    "isoAlpha3CountryCode": "string",
    "isoAlpha2CountryCode": "string",
    "isoNumericCountryCode": "string"
  },
  "recognitionStatus": "EMPTY",
  "fathersName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "mothersName": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "additionalProcessingInfo": {
    "missingMandatoryFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "invalidCharacterFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ],
    "extraPresentFields": [
      "ADDITIONAL_ADDRESS_INFORMATION"
    ]
  },
  "belowAgeLimit": true,
  "age": 0
}

Properties

Name Type Required Restrictions Description
firstName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The first name of the document owner.

continued

Name Type Required Restrictions Description
lastName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The last name of the document owner.

continued

Name Type Required Restrictions Description
fullName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The full name of the document owner.

continued

Name Type Required Restrictions Description
address any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The address of the document owner.

continued

Name Type Required Restrictions Description
dateOfIssue DateResult¦null false none none
dateOfExpiry DateResult¦null false none none
documentNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The document number.

continued

Name Type Required Restrictions Description
sex any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The sex of the document owner.

continued

Name Type Required Restrictions Description
driverLicenseDetailedInfo DriverLicenseDetailedInfo¦null false none The driver license detailed info.
fullDocumentImageBase64 string¦null false none The full document image.
faceImageBase64 string¦null false none The face image.
additionalNameInformation any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional name information of the document owner.

continued

Name Type Required Restrictions Description
additionalAddressInformation any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional address information of the document owner.

continued

Name Type Required Restrictions Description
additionalOptionalAddressInformation any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The one more additional address information of the document owner.

continued

Name Type Required Restrictions Description
placeOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The place of birth of the document owner.

continued

Name Type Required Restrictions Description
nationality any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The nationality of the documet owner.

continued

Name Type Required Restrictions Description
race any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The race of the document owner.

continued

Name Type Required Restrictions Description
religion any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The religion of the document owner.

continued

Name Type Required Restrictions Description
profession any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The profession of the document owner.

continued

Name Type Required Restrictions Description
maritalStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The marital status of the document owner.

continued

Name Type Required Restrictions Description
residentialStatus any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The residential stauts of the document owner.

continued

Name Type Required Restrictions Description
employer any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The employer of the document owner.

continued

Name Type Required Restrictions Description
personalIdNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The personal identification number.

continued

Name Type Required Restrictions Description
documentAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional number of the document.

continued

Name Type Required Restrictions Description
documentOptionalAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The one more additional number of the document.

continued

Name Type Required Restrictions Description
issuingAuthority any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The issuing authority of the document.

continued

Name Type Required Restrictions Description
mrzData MrzResult¦null false none The data extracted from the machine readable zone.
localizedName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The localized name of the document.

continued

Name Type Required Restrictions Description
dateOfExpiryPermanent boolean¦null false none Determines if date of expiry is permanent.
additionalPersonalIdNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional personal identification number.

continued

Name Type Required Restrictions Description
viz VIZResult¦null false none The data extracted from the visual inspection zone.
barcode BarcodeResult¦null false none The data extracted from the barcode.
imageAnalysisResult ImageAnalysisResult¦null false none Various information obtained by analysing the scanned image.
processingStatus ProcessingStatus¦null false none Detailed information about the recognition process.
recognitionMode RecognitionMode¦null false none Recognition mode used to scan current document.
signatureImageBase64 string¦null false none The signature image.
dateOfBirth DateResult¦null false none none
classInfo ClassInfo¦null false none The document class information.
recognitionStatus ResultState true none Possible states of the Recognizer's result.
fathersName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The fathers name of the document owner.

continued

Name Type Required Restrictions Description
mothersName any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The mothers name of the document owner.

continued

Name Type Required Restrictions Description
additionalProcessingInfo AdditionalProcessingInfo¦null false none The additional details about the processing info.
belowAgeLimit 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.

BlinkIdSingleSideRequest

{
  "returnFullDocumentImage": false,
  "returnFaceImage": false,
  "returnSignatureImage": false,
  "allowBlurFilter": true,
  "allowUnparsedMrzResults": false,
  "allowUnverifiedMrzResults": true,
  "validateResultCharacters": true,
  "anonymizationMode": "FULL_RESULT",
  "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 TRUE
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 AnonymizationMode false none Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT

continued

Name Type Required Restrictions Description
additionalAnonymization [ClassAnonymizationSettings]¦null false none [Redact fields for specific document class. Fields specified by requirements or laws for a specific document will be redacted regardless of this setting. Based on anonymizationMode setting, data will be redacted from the image, the result or both.]
ageLimit integer(int32)¦null false none Defines the age limit for age verification.
image ImageSource¦null true none Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.
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 AnonymizationMode false none Defines the mode of card number anonymization. Default 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

CardOrientation

"HORIZONTAL"

Card orientation

Properties

Name Type Required Restrictions Description
Card orientation string false none Orientation determined from the scanned image.

Enumerated Values

Property Value
Card orientation HORIZONTAL
Card orientation VERTICAL

ClassAnonymizationSettings

{
  "country": "COUNTRY_NONE",
  "region": "REGION_NONE",
  "type": "TYPE_NONE",
  "fields": [
    "ADDITIONAL_ADDRESS_INFORMATION"
  ]
}

Redact fields for specific document class. Fields specified by requirements or laws for a specific document will be redacted regardless of this setting. Based on anonymizationMode setting, data will be redacted from the image, the result or both.

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 If set, specified fields will be anonymized on documents issued by specified country only.Otherwise, issuing country will not be taken into account during anonymization.

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 If set, specified fields will be anonymized on documents issued by specified region only. Otherwise, issuing region will not be taken into account during anonymization.

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 If set, specified fields will be anonymized on documents issued by specified type only. Otherwise, document type will not be taken into account during anonymization.

continued

Name Type Required Restrictions Description
fields [FieldType]¦null true none Fields to be anonymized.

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 Country¦null false none Document country.
region Region¦null false none Document region.
type Type¦null false none Document type.
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

{
  "dateOfBirth": "NOT_PERFORMED",
  "dateOfExpiry": "NOT_PERFORMED",
  "documentNumber": "NOT_PERFORMED",
  "documentAdditionalNumber": "NOT_PERFORMED",
  "documentOptionalAdditionalNumber": "NOT_PERFORMED",
  "personalIdNumber": "NOT_PERFORMED",
  "dataMatchResult": "NOT_PERFORMED"
}

Result of data match check.

Properties

Name Type Required Restrictions Description
dateOfBirth any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on date of birth field.

continued

Name Type Required Restrictions Description
dateOfExpiry any true none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on date of expiry field.

continued

Name Type Required Restrictions Description
documentNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on document number field.

continued

Name Type Required Restrictions Description
documentAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on document additional number field.

continued

Name Type Required Restrictions Description
documentOptionalAdditionalNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on document optional additional number field.

continued

Name Type Required Restrictions Description
personalIdNumber any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on personal ID number field.

continued

Name Type Required Restrictions Description
dataMatchResult any false none none

allOf

Name Type Required Restrictions Description
» anonymous DataMatchState false none none

and

Name Type Required Restrictions Description
» anonymous any false none The result of data match on the whole document.

DataMatchState

"NOT_PERFORMED"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous NOT_PERFORMED
anonymous FAILED
anonymous SUCCESS

Date

{
  "day": 0,
  "month": 0,
  "year": 0,
  "successfullyParsed": true,
  "filledByDomainKnowledge": 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
filledByDomainKnowledge boolean¦null false none True if date was filled by domain knowledge
originalString string¦null false none String used in date parsing

DateResult

{
  "day": 0,
  "month": 0,
  "year": 0,
  "successfullyParsed": true,
  "filledByDomainKnowledge": true,
  "originalString": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "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
filledByDomainKnowledge boolean¦null false none True if date was filled by domain knowledge
originalString any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any 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": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "endorsements": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "vehicleClass": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "conditions": {
    "latin": "string",
    "cyrillic": "string",
    "arabic": "string"
  },
  "vehicleClassesInfo": [
    {
      "vehicleClass": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "licenceType": {
        "latin": "string",
        "cyrillic": "string",
        "arabic": "string"
      },
      "effectiveDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      },
      "expiryDate": {
        "day": 0,
        "month": 0,
        "year": 0,
        "successfullyParsed": true,
        "filledByDomainKnowledge": true,
        "originalString": {
          "latin": "string",
          "cyrillic": "string",
          "arabic": "string"
        }
      }
    }
  ]
}

The driver license detailed info.

Properties

Name Type Required Restrictions Description
restrictions any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The restrictions to driving privileges for the United States driver license owner.

continued

Name Type Required Restrictions Description
endorsements any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The additional privileges granted to the United States driver license owner.

continued

Name Type Required Restrictions Description
vehicleClass any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The type of vehicle the driver license owner has privilege to drive.

continued

Name Type Required Restrictions Description
conditions any false none none

allOf

Name Type Required Restrictions Description
» anonymous StringResult false none none

and

Name Type Required Restrictions Description
» anonymous any false none The driver license conditions.

continued

Name Type Required Restrictions Description
vehicleClassesInfo [VehicleClassInfo]¦null false none The additional information on vehicle class.

FieldType

"ADDITIONAL_ADDRESS_INFORMATION"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous ADDITIONAL_ADDRESS_INFORMATION
anonymous ADDITIONAL_NAME_INFORMATION
anonymous ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION
anonymous ADDITIONAL_PERSONAL_ID_NUMBER
anonymous ADDRESS
anonymous CLASS_EFFECTIVE_DATE
anonymous CLASS_EXPIRY_DATE
anonymous CONDITIONS
anonymous DATE_OF_BIRTH
anonymous DATE_OF_EXPIRY
anonymous DATE_OF_ISSUE
anonymous DOCUMENT_ADDITIONAL_NUMBER
anonymous DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER
anonymous DOCUMENT_NUMBER
anonymous EMPLOYER
anonymous ENDORSEMENTS
anonymous FATHERS_NAME
anonymous FIRST_NAME
anonymous FULL_NAME
anonymous ISSUING_AUTHORITY
anonymous LAST_NAME
anonymous LICENCE_TYPE
anonymous LOCALIZED_NAME
anonymous MARITAL_STATUS
anonymous MOTHERS_NAME
anonymous MRZ
anonymous NATIONALITY
anonymous PERSONAL_ID_NUMBER
anonymous PLACE_OF_BIRTH
anonymous PROFESSION
anonymous RACE
anonymous RELIGION
anonymous RESIDENTIAL_STATUS
anonymous RESTRICTIONS
anonymous SEX
anonymous VEHICLE_CLASS
anonymous BLOOD_TYPE
anonymous SPONSOR

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¦null true none none
operational boolean¦null true none none
severity integer(int32)¦null 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
IdBarcode document type PARAGUAY_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",
    "la