Integration with Face SDK

The integration of Face SDK to Document Reader adds an automatic face match and search by a portrait taken from the document (Visual Zone and RFID-chip) or a live owner photo.

└── FaceApiParams
|   └── url
|   └── mode
|   └── search
|   |   └── limit
|   |   └── threshold
|   |   └── groupIds    
|   └── threshold    
|   └── serviceTimeout
|   └── proxy
|   └── proxyUserPwd
|   └── proxyType

Parameter	Default	Description
url	https://faceapi.regulaforensics.com	The URL of the Regula Face SDK service instance to be used. Note that the default https://faceapi.regulaforensics.com can be used for demo purposes only. For production use, you should purchase an appropriate license. Please contact us here.
mode	match	The processing mode: "match" or "match+search". match is a comparison of persons that are passed in the request, works by default. match+search performs both matching and searching by image. If only one person is available, match is not performed and only the search is carried out. If no search parameters are specified, the search is conducted over the entire database with the default parameters. Learn more in OpenAPI documentation
search	not set	A search filter that can be applied if the "match+search" mode is enabled. May include limit, threshold, group_ids. If the group_ids are specified, the search is performed only in these groups. Find more information in the OpenAPI documentation.
threshold	75	The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.
serviceTimeout	3000	The service request timeout, ms.
proxy	not set	Proxy to use, should be set according to the cURL standard.
proxyUserPwd	not set	Username and password to use for proxy authentication, should be set according to the cURL standard.
proxyType	not set	Proxy protocol type, should be set according to the cURL standard.

To add the Face API integration, invoke:

SwiftObjective-C Kotlin Java Flutter React Native Ionic Cordova.NET MAUI

let faceApiParams = FaceAPIParams()
faceApiParams.url = "url"
faceApiParams.mode = "match"
faceApiParams.threshold = 90
faceApiParams.proxy = "proxy"
faceApiParams.proxyPassword = "user_pwd"
faceApiParams.proxyType = 1

let faceApiSearchParams = RGLFaceAPISearchParams()
faceApiSearchParams.limit = 100
faceApiSearchParams.threshold = 0.9
faceApiSearchParams.groupIDs = [1, 2, 3]
faceApiParams.searchParams = faceApiSearchParams

DocReader.shared.processParams.useFaceApi = true
DocReader.shared.processParams.faceApiParams = faceApiParams

RGLFaceAPIParams *faceApiParams = [[RGLFaceAPIParams alloc] init];
faceApiParams.url = @"url";
faceApiParams.mode = @"match";
faceApiParams.threshold = @90;
faceApiParams.proxy = @"proxy";
faceApiParams.proxyPassword = @"user_pwd";
faceApiParams.proxyType = @1;

RGLFaceAPISearchParams *faceApiSearchParams = [[RGLFaceAPISearchParams alloc] init];
faceApiSearchParams.limit = @100;
faceApiSearchParams.threshold = @0.9f;
faceApiSearchParams.groupIDs = @[@1, @2, @3];
faceApiParams.searchParams = faceApiSearchParams;

RGLDocReader.shared.processParams.useFaceApi = @YES;
RGLDocReader.shared.processParams.faceApiParams = faceApiParams;

val faceApiParams = FaceApiParams()
faceApiParams.url = "url"
faceApiParams.mode = "mode"
faceApiParams.serviceTimeout = 4000
faceApiParams.threshold = 90
faceApiParams.proxy = "proxy"
faceApiParams.proxyUserPwd = "user_pwd"
faceApiParams.proxyType = 1

val search = FaceApiParams.Search()
search.limit = 100
search.threshold = 0.9f
search.groupIds = intArrayOf(1, 2, 3)

faceApiParams.search = search

DocumentReader.Instance().processParams().faceApiParams = faceApiParams

FaceApiParams faceApiParams = new FaceApiParams();
faceApiParams.setUrl("url");
faceApiParams.setMode("mode");
faceApiParams.setServiceTimeout(4000);
faceApiParams.setThreshold(90);
faceApiParams.setProxy("proxy");
faceApiParams.setProxyUserPwd("user_pwd");
faceApiParams.setProxyType(1);

FaceApiParams.Search search = new FaceApiParams.Search();
search.setLimit(100);
search.setThreshold(0.9f);
search.setGroupIds(new int[]{1, 2, 3});

faceApiParams.setSearch(search);

DocumentReader.Instance().processParams().faceApiParams = faceApiParams;

var faceApiParams = FaceApiParams(
    url: "https://faceapi.regulaforensics.com/",
    mode: "match+search",
    serviceTimeout: 2000,
    threshold: 90,
    proxy: "https://example.com/",
    proxyPassword: "Regula%20user:StrongPassword",
    proxyType: 2,
    searchParams: FaceApiSearchParams(
      limit: 100,
      threshold: 0.9,
      groupIds: [1, 2, 3],
    ));

DocumentReader.instance.processParams.useFaceApi = true;
DocumentReader.instance.processParams.faceApiParams = faceApiParams;

var faceApiParams = new FaceApiParams()
faceApiParams.url = "https://faceapi.regulaforensics.com/"
faceApiParams.mode = "match+search"
faceApiParams.serviceTimeout = 2000
faceApiParams.threshold = 90
faceApiParams.proxy = "https://example.com/"
faceApiParams.proxyPassword = "Regula%20user:StrongPassword"
faceApiParams.proxyType = 2

var search = new Search()
search.limit = 100
search.threshold = 0.9
search.groupIds = [1, 2, 3]
faceApiParams.searchParams = search

DocumentReader.setProcessParams({
    useFaceApi: true,
    faceApiParams: faceApiParams,
}, _ => { }, _ => { })

var faceApiParams = new FaceApiParams()
faceApiParams.url = "https://faceapi.regulaforensics.com/"
faceApiParams.mode = "match+search"
faceApiParams.serviceTimeout = 2000
faceApiParams.threshold = 90
faceApiParams.proxy = "https://example.com/"
faceApiParams.proxyPassword = "Regula%20user:StrongPassword"
faceApiParams.proxyType = 2

var search = new Search()
search.limit = 100
search.threshold = 0.9
search.groupIds = [1, 2, 3]
faceApiParams.searchParams = search

DocumentReader.setProcessParams({
    useFaceApi: true,
    faceApiParams: faceApiParams,
})

var faceApiParams = new FaceApiParams()
faceApiParams.url = "https://faceapi.regulaforensics.com/"
faceApiParams.mode = "match+search"
faceApiParams.serviceTimeout = 2000
faceApiParams.threshold = 90
faceApiParams.proxy = "https://example.com/"
faceApiParams.proxyPassword = "Regula%20user:StrongPassword"
faceApiParams.proxyType = 2

var search = new Search()
search.limit = 100
search.threshold = 0.9
search.groupIds = [1, 2, 3]
faceApiParams.searchParams = search

DocumentReader.setProcessParams({
    useFaceApi: true,
    faceApiParams: faceApiParams,
}, function (s) { }, function (e) { })

// Android
FaceApiParams faceApiParams = new()
{
    Url = "url",
    Mode = "mode",
    ServiceTimeout = 4000,
    Threshold = 90,
    Proxy = "proxy",
    ProxyUserPwd = "user_pwd",
    ProxyType = (Java.Lang.Integer)1
};

FaceApiParams.Search search = new()
{
    Limit = 100,
    Threshold = 0.9f
};
search.SetGroupIds(new int[] { 1, 2, 3 });

faceApiParams.SetSearch(search);

DocumentReader.Instance().ProcessParams().UseFaceApi = (Java.Lang.Boolean)true;
DocumentReader.Instance().ProcessParams().FaceApiParams = faceApiParams;

// iOS
RGLFaceAPIParams faceApiParams = new()
{
    Url = "url",
    Mode = "match",
    Threshold = 90,
    Proxy = "proxy",
    ProxyPassword = "user_pwd",
    ProxyType = 1
};

RGLFaceAPISearchParams faceApiSearchParams = new()
{
    Limit = 100,
    Threshold = 0.9f,
    GroupIDs = new NSNumber[] { 1, 2, 3 }
};
faceApiParams.SearchParams = faceApiSearchParams;

RGLDocReader.Shared.ProcessParams.UseFaceApi = true;
RGLDocReader.Shared.ProcessParams.FaceApiParams = faceApiParams;

Integration with Face SDK

Next Steps