Import ID Analyzer Client Library

To start, import ID Analyzer client library into your project.

// Use composer autoload
require("vendor/autoload.php");

// Or manually load DocuPass class
// require("../src/Vault.php");

use IDAnalyzer\Vault; 

using IDAnalyzer;

const IDAnalyzer = require("idanalyzer");  

import idanalyzer

Initialize Vault

The very first step is to initialize Vault with your API Key, you should also set an API region (US or EU).

$vault = new Vault("API Key", "US");  

Vault vault = new Vault("Your API Key", "US");

let Vault = new IDAnalyzer.Vault("Your API Key", "US");  

vault = idanalyzer.Vault("Your API Key", "US")

Get Single Vault Entry

The most common operation is retrieving customer information from Vault, using Vault ID generated by Core API or DocuPass.

$result = $vault->get("Vault ID");

JObject result = await vault.Get("Vault ID");

let result = await Vault.get("Vault ID");

result = vault.get("Vault ID")

List & Search Through Vault

Another common operation to list the entries in Vault. The following example list 5 items created on or after 2021/02/25, sorted by first name in ascending order, starting from first item.

$result = $vault->list(array("createtime>=2021/02/25"), "firstName","ASC", 5, 0);

string[] filter = { "createtime>=2021/02/25" };
JObject result = await vault.List(filter, "firstName", "ASC", 5, 0);

let result = Vault.list({filter: ["createtime>=2021/02/25"], orderby: "firstName", sort: "ASC", limit: 5, offset: 0});

result = vault.list(filter=["createtime>=2021/02/25"], orderby="firstName", sort="ASC", limit=5, offset=0)

You can also search the vault for a particular person.

$result = $vault->list(array("firstName=Elon","lastName=Musk"), "createtime", "DESC", 5, 0);

string[] filter = { "firstName=Elon","lastName=Musk" };
JObject result = await vault.List(filter, "createtime", "DESC", 5, 0);

let result = Vault.list({filter: ["firstName=Elon","lastName=Musk"], orderby: "createtime", sort: "DESC", limit: 5, offset: 0});

result = vault.list(filter=["firstName=Elon","lastName=Musk"], orderby="createtime", sort="DESC", limit=5, offset=0)

To make better use of the Vault's search feature, you should read Vault API Reference for supported fields and operators.

Face Search

Face search allows you to search the entire vault using face of a person. To use face search feature, you must enable face search indexing under web portal, and train your vault datasets periodically. Only data added after you have enabled face search under web portal will be searchable. The following examples will search the vault using face.jpg image, with a confidence threshold of 0.5, and returns maximum of 1 result.

$result = $vault->searchFace("face.jpg", 1, 0.5);

JObject result = await vault.SearchFace("face.jpg", 1, 0.5);

let result = await Vault.searchFace("face.jpg", 1, 0.5);

result = vault.search_face("face.jpg", 1, 0.5)

To read the complete list of methods and parameters for ID Analyzer Client library, visit the link below: