Class Vault

Biometric-search enabled database to securely store and query your user's identity information and documents

Inheritance

System.Object

Vault

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: IDAnalyzer

Assembly: IDAnalyzer.dll

Syntax

public class Vault

Constructors

| Improve this Doc View Source

Vault(String, String)

Initialize Vault API with an API key, and optional region (US, EU)

Declaration

public Vault(string apikey, string region = "US")

Parameters

Type	Name	Description
System.String	apikey	You API key
System.String	region	US/EU

Methods

| Improve this Doc View Source

AddImage(String, String, Int32)

Add a document or face image into an existing vault entry

Declaration

public Task<JObject> AddImage(string vault_id, string image, int type = 0)

Parameters

Type	Name	Description
System.String	vault_id	Vault entry ID
System.String	image	Image file path, base64 content or URL
System.Int32	type	Type of image: 0 = document, 1 = person

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>

| Improve this Doc View Source

Delete(String[])

Delete a single or multiple vault entries

Declaration

public Task<bool> Delete(string[] vault_id)

Parameters

Type	Name	Description
System.String[]	vault_id	Vault entry ID array

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

| Improve this Doc View Source

DeleteImage(String, String)

Delete an image from vault

Declaration

public Task<bool> DeleteImage(string vault_id, string image_id)

Parameters

Type	Name	Description
System.String	vault_id	Vault entry ID
System.String	image_id	Image ID

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

| Improve this Doc View Source

Get(String)

Get a single vault entry

Declaration

public Task<JObject> Get(string vault_id = "")

Parameters

Type	Name	Description
System.String	vault_id	Vault entry ID

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>	Vault entry data

| Improve this Doc View Source

List(String[], String, String, Int32, Int32)

List multiple vault entries with optional filter, sorting and paging arguments

Declaration

public Task<JObject> List(string[] filter, string orderby = "createtime", string sort = "DESC", int limit = 10, int offset = 0)

Parameters

Type	Name	Description
System.String[]	filter	Array of filter statements, refer to https://developer.idanalyzer.com/vaultapi.html for filter construction
System.String	orderby	Field name used to order the results, refer to https://developer.idanalyzer.com/vaultapi.html for available fields
System.String	sort	Sort results by ASC = Ascending, DESC = DESCENDING
System.Int32	limit	Number of results to return
System.Int32	offset	Offset the first result using specified index

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>	Vault entry list

| Improve this Doc View Source

SearchFace(String, Int32, Double)

Search vault using a person's face image

Declaration

public Task<JObject> SearchFace(string image, int maxEntry = 10, double threshold = 0.5)

Parameters

Type	Name	Description
System.String	image	Face image file path, base64 content or URL
System.Int32	maxEntry	Number of entries to return, 1 to 10.
System.Double	threshold	Minimum confidence score required for face matching

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>

| Improve this Doc View Source

ThrowAPIException(Boolean)

Raise APIException when API returns an error

Declaration

public void ThrowAPIException(bool throwException = false)

Parameters

Type	Name	Description
System.Boolean	throwException	Enable or Disable APIException being thrown

| Improve this Doc View Source

TrainFace()

Train vault for face search

Declaration

public Task<JObject> TrainFace()

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>

| Improve this Doc View Source

TrainingStatus()

Get vault training status

Declaration

public Task<JObject> TrainingStatus()

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>

| Improve this Doc View Source

Update(String, Hashtable)

Update vault entry with new data

Declaration

public Task<JObject> Update(string vault_id, Hashtable data)

Parameters

Type	Name	Description
System.String	vault_id	Vault entry ID
System.Collections.Hashtable	data	Key-value hashtable of the field name and its value

Returns

Type	Description
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject>