FacePhi SelphID SDK DotNet API
Loading...
Searching...
No Matches
SelphIDVerifierNet.h
1#pragma once
2
3#include "SelphIDVerifier.h"
4#include "SelphIDFacialAuthenticationResultNet.h"
5#include "SelphIDVerifierResultNet.h"
6#include "SelphIDVerifierOptionsNet.h"
7#include "SelphIDRawTemplateInfoNet.h"
8#include "SelphIDFacialLivenessResultNet.h"
9#include "SelphIDApiTrackingResultNet.h"
10#include "SelphIDExceptionNet.h"
11
12using namespace System;
13using namespace System::Collections::Generic;
14
15namespace FPhiSelphIDNet {
19public
20ref class SelphIDVerifier sealed {
21 private:
22 FPhiSelphID::SelphIDVerifier *_verifier;
23
24 public:
29
34
39
44 void Load();
45
51 void LoadWithConfigPath(String ^ configFilePath);
52
58
63 void Unload();
64
69 String ^ GetVersion();
70
79 ExtractFacialWithImageBuffer(array<Byte> ^ imageBuffer, SelphIDVerifierOptions ^ verifierOptions);
80
89 ExtractFacialWithRawTemplate(array<Byte> ^ rawTemplateBuffer, SelphIDVerifierOptions ^ verifierOptions);
90
101 SelphIDFacialExtractionResult ^ extractionResultTarget,
102 SelphIDVerifierOptions ^ verifierOptions);
103
113 array<Byte> ^ imageBufferTarget,
114 SelphIDVerifierOptions ^ verifierOptions);
115
125 array<Byte> ^ rawTemplateBufferTarget,
126 SelphIDVerifierOptions ^ verifierOptions);
127
138 AuthenticateFacialWithRawTemplates(array<Byte> ^ rawTemplateBufferQuery, array<Byte> ^ rawTemplateBufferTarget,
139 array<Byte> ^ extraData, SelphIDVerifierOptions ^ verifierOptions);
140
150 array<Byte> ^ facialTemplateBufferTarget,
151 SelphIDVerifierOptions ^ verifierOptions);
152
161 ExtractDocumentWithRawDocument(array<Byte> ^ rawDocumentBuffer, SelphIDVerifierOptions ^ verifierOptions);
162
171 SelphIDDocumentResult ^ ExtractDocumentWithRawDocument(array<Byte> ^ rawDocumentBuffer, array<Byte> ^ extraData,
172 SelphIDVerifierOptions ^ verifierOptions);
173
182 VerifyDocumentWithRawDocument(array<Byte> ^ rawDocumentBuffer, SelphIDVerifierOptions ^ verifierOptions);
183
193 AuthenticateFacialWithRawDocumentRawTemplate(array<Byte> ^ rawDocumentBufferQuery,
194 array<Byte> ^ rawTemplateBufferTarget,
195 SelphIDVerifierOptions ^ verifierOptions);
196
207 AuthenticateFacialWithRawDocumentRawTemplate(array<Byte> ^ rawDocumentBufferQuery,
208 array<Byte> ^ rawTemplateBufferTarget, array<Byte> ^ extraData,
209 SelphIDVerifierOptions ^ verifierOptions);
210
220 array<Byte> ^ rawTemplateBufferTarget,
221 SelphIDVerifierOptions ^ verifierOptions);
222
232 AuthenticateFacialWithRawDocumentImage(array<Byte> ^ rawDocumentBufferQuery, array<Byte> ^ imageBufferTarget,
233 SelphIDVerifierOptions ^ verifierOptions);
234
245 AuthenticateFacialWithRawDocumentImage(array<Byte> ^ rawDocumentBufferQuery, array<Byte> ^ imageBufferTarget,
246 array<Byte> ^ extraData, SelphIDVerifierOptions ^ verifierOptions);
247
256 SelphIDVerifierResult ^ VerifySelphIDWithRawDocumentImage(array<Byte> ^ rawDocumentBufferQuery,
257 array<Byte> ^ imageBufferTarget,
258 SelphIDVerifierOptions ^ verifierOptions);
259
269 AuthenticateFacialWithImageRawTemplate(array<Byte> ^ imageBufferQuery, array<Byte> ^ rawTemplateBufferTarget,
270 SelphIDVerifierOptions ^ verifierOptions);
271
282 AuthenticateFacialWithImageRawTemplate(array<Byte> ^ imageBufferQuery, array<Byte> ^ rawTemplateBufferTarget,
283 array<Byte> ^ extraData, SelphIDVerifierOptions ^ verifierOptions);
284
299 String ^ source, array<Byte> ^ imageBufferQuery,
300 array<Byte> ^ imageBufferTarget, array<Byte> ^ extraData);
301
312 OperationResultReason reason, array<Byte> ^ extraData);
313
324 SecurityInfoTrackingEvent(String ^ securityDataJson, bool succeed, String ^ source, array<Byte> ^ extraData);
325
334 SelphIDApiTrackingResult ^ OCRTrackingEvent(String ^ ocrDataJson, String ^ source, array<Byte> ^ extraData);
335
343 array<Byte> ^ SetTrackingEventSource(String ^ eventSource, array<Byte> ^ extraData);
344
355 void SetTrackingProxy(String ^ proxyHost, unsigned short proxyPort, String ^ proxyUser, String ^ proxyPass);
356
366 array<Byte> ^ rawTemplateBufferTarget,
367 SelphIDVerifierOptions ^ verifierOptions);
368
379 VerifySelphIDWithImageRawTemplate(array<Byte> ^ imageBufferQuery, array<Byte> ^ rawTemplateBufferTarget,
380 array<Byte> ^ extraData, SelphIDVerifierOptions ^ verifierOptions);
381
390 SelphIDVerifierResult ^ VerifySelphIDWithRawTemplates(array<Byte> ^ rawTemplateBufferQuery,
391 array<Byte> ^ rawTemplateBufferTarget,
392 SelphIDVerifierOptions ^ verifierOptions);
393
404 VerifySelphIDWithRawTemplates(array<Byte> ^ rawTemplateBufferQuery, array<Byte> ^ rawTemplateBufferTarget,
405 array<Byte> ^ extraData, SelphIDVerifierOptions ^ verifierOptions);
406
413 SelphIDRawTemplateInfo ^ GetRawTemplateInfo(array<Byte> ^ rawTemplateBuffer);
414
421 int GetFacialTemplateVersion(array<Byte> ^ facialTemplateBuffer);
422
430
439 EvaluatePassiveLivenesWithImageBuffer(array<Byte> ^ imageBuffer, array<Byte> ^ extraData);
440
449 EvaluatePassiveLivenessWithTokenBuffer(array<Byte> ^ tokenBuffer, SelphIDVerifierOptions ^ verifierOptions);
450
460 array<Byte> ^ extraData,
461 SelphIDVerifierOptions ^ verifierOptions);
462
469 void SetMultitenantMode(bool multiTenant);
470
477
484};
485} // namespace FPhiSelphIDNet
TrackingFamily
Family of Api tracking operation.
Definition SelphIDConstantsNet.h:427
OperationResultReason
Reason for api tracking finish events.
Definition SelphIDConstantsNet.h:469
FacialAuthenticationStatus
Facial Authentication status.
Definition SelphIDConstantsNet.h:10
OperationResultStatus
Status of Api tracking operation.
Definition SelphIDConstantsNet.h:443
SelphID Api Tracking Result.
Definition SelphIDApiTrackingResultNet.h:14
SelphIDDocumentResult.
Definition SelphIDDocumentResultNet.h:13
SelphIDFacialAuthenticationResult.
Definition SelphIDFacialAuthenticationResultNet.h:13
SelphIDFacialExtractionResult.
Definition SelphIDFacialExtractionResultNet.h:14
SelphID Facial Liveness Result.
Definition SelphIDFacialLivenessResultNet.h:14
SelphIDRawTemplateInfo.
Definition SelphIDRawTemplateInfoNet.h:11
FacePhi SelphID verifier.
Definition SelphIDVerifierNet.h:20
void LoadWithConfigPath(String ^ configFilePath)
Performs parameter and module loading.
SelphIDVerifier()
Creates a new instance of SelphIDVerifier.
SelphIDApiTrackingResult ^ AuthenticateFacialTrackingEvent(TrackingFamily family, FacialAuthenticationStatus authStatus, float similarity, String ^ source, array< Byte > ^ imageBufferQuery, array< Byte > ^ imageBufferTarget, array< Byte > ^ extraData)
Send a "Facial authentication" event in API Tracking. Also can upload the authentication images.
void Unload()
Performs module deallocation and free memory.
SelphIDFacialLivenessResult ^ EvaluatePassiveLivenessWithTokenBuffer(array< Byte > ^ tokenBuffer, SelphIDVerifierOptions ^ verifierOptions)
Evaluate face passive liveness.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawTemplates(array< Byte > ^ rawTemplateBufferQuery, array< Byte > ^ rawTemplateBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw template buffers with verifier options.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawTemplates(array< Byte > ^ rawTemplateBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw template buffers with verifier options.
void LoadFromEnvVars()
Performs parameter and module loading from environment variables.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithImageBuffers(array< Byte > ^ imageBufferQuery, array< Byte > ^ imageBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from facial image buffers.
SelphIDVerifierResult ^ VerifySelphIDWithImageRawTemplate(array< Byte > ^ imageBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and passive liveness with image buffer, raw template and verifier ...
SelphIDVerifierResult ^ VerifySelphIDWithRawTemplates(array< Byte > ^ rawTemplateBufferQuery, array< Byte > ^ rawTemplateBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and passive liveness with raw templates and verifier options....
SelphIDFacialExtractionResult ^ ExtractFacialWithRawTemplate(array< Byte > ^ rawTemplateBuffer, SelphIDVerifierOptions ^ verifierOptions)
Extracts facial template from template raw buffer.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithImageRawTemplate(array< Byte > ^ imageBufferQuery, array< Byte > ^ rawTemplateBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawDocumentRawTemplate(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ rawTemplateBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawDocumentImage(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ imageBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
SelphIDDocumentResult ^ ExtractDocumentWithRawDocument(array< Byte > ^ rawDocumentBuffer, SelphIDVerifierOptions ^ verifierOptions)
Extracts document data from raw document.
SelphIDFacialLivenessResult ^ EvaluatePassiveLivenesWithImageBuffer(array< Byte > ^ imageBuffer, array< Byte > ^ extraData)
Evaluate face passive liveness.
SelphIDDocumentResult ^ ExtractDocumentWithRawDocument(array< Byte > ^ rawDocumentBuffer, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Extracts document data from raw document.
SelphIDFacialLivenessResult ^ EvaluatePassiveLivenessWithTokenBuffer(array< Byte > ^ tokenBuffer, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Evaluate face passive liveness.
SelphIDVerifierResult ^ VerifySelphIDWithImageRawTemplate(array< Byte > ^ imageBufferQuery, array< Byte > ^ rawTemplateBufferTarget, array< Byte > ^ extraData, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and passive liveness with image buffer, raw template and verifier ...
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawDocumentRawTemplate(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
SelphIDFacialExtractionResult ^ ExtractFacialWithImageBuffer(array< Byte > ^ imageBuffer, SelphIDVerifierOptions ^ verifierOptions)
Extracts facial template from image buffer.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithExtractionResults(SelphIDFacialExtractionResult ^ extractionResultQuery, SelphIDFacialExtractionResult ^ extractionResultTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from facial extraction results.
bool IsSDKAlive()
Get if SDK is alive.
SelphIDApiTrackingResult ^ SecurityInfoTrackingEvent(String ^ securityDataJson, bool succeed, String ^ source, array< Byte > ^ extraData)
Send a "SECURITY_INFO_DATA" event in API Tracking, based on security results.
SelphIDDocumentResult ^ VerifyDocumentWithRawDocument(array< Byte > ^ rawDocumentBuffer, SelphIDVerifierOptions ^ verifierOptions)
Verify document data from raw document.
int GetFacialTemplateVersion(array< Byte > ^ facialTemplateBuffer)
Gets facial template version.
SelphIDVerifierResult ^ VerifySelphIDWithRawTemplates(array< Byte > ^ rawTemplateBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and passive liveness with raw templates and verifier options....
SelphIDRawTemplateInfo ^ GetRawTemplateInfo(array< Byte > ^ rawTemplateBuffer)
Gets raw template information.
~SelphIDVerifier()
SelphIDVerifier destructor.
void SetMultitenantMode(bool multiTenant)
Turns on or off the API tracking multitenant functionality.
array< Byte > ^ SetTrackingEventSource(String ^ eventSource, array< Byte > ^ extraData)
Change the event source value in extraData token.
String ^ GetVersion()
Gets SelphID version string.
SelphIDVerifierResult ^ VerifySelphIDWithRawDocumentImage(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ imageBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and document verification with verifier options.
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithRawDocumentImage(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ imageBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
void Load()
Performs parameter and module loading.
SelphIDApiTrackingResult ^ FinishTrackingEvent(TrackingFamily family, OperationResultStatus status, OperationResultReason reason, array< Byte > ^ extraData)
Send a "Operation result" and "Step change finish" events in API Tracking.
SelphIDApiTrackingResult ^ OCRTrackingEvent(String ^ ocrDataJson, String ^ source, array< Byte > ^ extraData)
Send a custom OCR Data event in API Tracking.
SelphIDFacialLivenessResult ^ EvaluatePassiveLivenesWithImageBuffer(array< Byte > ^ imageBuffer)
Evaluate face passive liveness.
void SetTrackingProxy(String ^ proxyHost, unsigned short proxyPort, String ^ proxyUser, String ^ proxyPass)
Set proxy parameters for API Tracking. After calling this function, all requests to the tracking API ...
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithImageRawTemplate(array< Byte > ^ imageBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from raw document and raw facial template buffers with verifier op...
SelphIDFacialAuthenticationResult ^ AuthenticateFacialWithFacialTemplates(array< Byte > ^ facialTemplateBufferQuery, array< Byte > ^ facialTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Authenticates two facial templates from facial template buffers with verifier options.
bool IsMultitenantEnabled()
Checks if SelphID is running in multitenant or monotenant mode.
SelphIDVerifierResult ^ VerifySelphIDWithRawDocumentRawTemplate(array< Byte > ^ rawDocumentBufferQuery, array< Byte > ^ rawTemplateBufferTarget, SelphIDVerifierOptions ^ verifierOptions)
Performs the facial authentication and document verification verifier options.
SelphIDVerifierOptions.
Definition SelphIDVerifierOptionsNet.h:13
SelphIDVerifierResult.
Definition SelphIDVerifierResultNet.h:13