SelphIDVerifier.h

#ifndef SELPHIDVERIFIER_H_
#define SELPHIDVERIFIER_H_
 
#include "FPhiDefines.hpp"
#include "SelphIDDocumentResult.h"
#include "SelphIDFacialAuthenticationResult.h"
#include "SelphIDFacialExtractionResult.h"
#include "SelphIDVerifierOptions.h"
#include "SelphIDVerifierResult.h"
#include "SelphIDRawTemplateInfo.h"
#include "SelphIDFacialLivenessResult.h"
#include "SelphIDApiTrackingResult.h"
#include "SelphIDException.h"
 
namespace FPhiSelphID {
class SelphIDVerifier {
  public:
    DLL_PUBLIC SelphIDVerifier();
 
    DLL_PUBLIC ~SelphIDVerifier();
 
    DLL_PUBLIC void Load();
 
    DLL_PUBLIC void LoadWithConfigPath(const std::string &configFilePath);
 
    DLL_PUBLIC void LoadFromEnvVars();
 
    DLL_PUBLIC void Unload();
 
    DLL_PUBLIC std::string GetVersion();
 
    DLL_PUBLIC SelphIDFacialExtractionResult ExtractFacialWithImageBuffer(
        const std::vector<unsigned char> &imageBuffer, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialExtractionResult ExtractFacialWithRawTemplate(
        const std::vector<unsigned char> &rawTemplateBuffer, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithExtractionResults(
        const SelphIDFacialExtractionResult &extractionResultQuery,
        const SelphIDFacialExtractionResult &extractionResultTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithImageBuffers(
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &imageBufferTarget,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawTemplates(
        const std::vector<unsigned char> &rawTemplateBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawTemplates(
        const std::vector<unsigned char> &rawTemplateBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const std::vector<unsigned char> &extraData,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithFacialTemplates(
        const std::vector<unsigned char> &facialTemplateBufferQuery,
        const std::vector<unsigned char> &facialTemplateBufferTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDDocumentResult ExtractDocumentWithRawDocument(const std::vector<unsigned char> &rawDocumentBuffer,
                                                                    const SelphIDVerifierOptions     &verifierOptions);
 
    DLL_PUBLIC SelphIDDocumentResult ExtractDocumentWithRawDocument(const std::vector<unsigned char> &rawDocumentBuffer,
                                                                    const std::vector<unsigned char> &extraData,
                                                                    const SelphIDVerifierOptions     &verifierOptions);
 
    DLL_PUBLIC SelphIDDocumentResult VerifyDocumentWithRawDocument(const std::vector<unsigned char> &rawDocumentBuffer,
                                                                   const SelphIDVerifierOptions     &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawDocumentRawTemplate(
        const std::vector<unsigned char> &rawDocumentBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawDocumentRawTemplate(
        const std::vector<unsigned char> &rawDocumentBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const std::vector<unsigned char> &extraData,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithRawDocumentRawTemplate(
        const std::vector<unsigned char> &rawDocumentBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawDocumentImage(
        const std::vector<unsigned char> &rawDocumentBufferQuery, const std::vector<unsigned char> &imageBufferTarget,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithRawDocumentImage(
        const std::vector<unsigned char> &rawDocumentBufferQuery, const std::vector<unsigned char> &imageBufferTarget,
        const std::vector<unsigned char> &extraData, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithRawDocumentImage(
        const std::vector<unsigned char> &rawDocumentBufferQuery, const std::vector<unsigned char> &imageBufferTarget,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithImageRawTemplate(
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &rawTemplateBufferTarget,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialAuthenticationResult AuthenticateFacialWithImageRawTemplate(
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &rawTemplateBufferTarget,
        const std::vector<unsigned char> &extraData, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDApiTrackingResult AuthenticateFacialTrackingEvent(
        TrackingFamily family, FacialAuthenticationStatus authStatus, float similarity, const std::string &source,
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &imageBufferTarget,
        const std::vector<unsigned char> &extraData);
 
    DLL_PUBLIC SelphIDApiTrackingResult FinishTrackingEvent(TrackingFamily family, OperationResultStatus status,
                                                            OperationResultReason             reason,
                                                            const std::vector<unsigned char> &extraData);
 
    DLL_PUBLIC SelphIDApiTrackingResult SecurityInfoTrackingEvent(const std::string &securityDataJson, bool succeed,
                                                                  const std::string                &source,
                                                                  const std::vector<unsigned char> &extraData);
 
    DLL_PUBLIC SelphIDApiTrackingResult OCRTrackingEvent(const std::string &ocrDataJson, const std::string &source,
                                                         const std::vector<unsigned char> &extraData);
 
    DLL_PUBLIC std::vector<unsigned char> SetTrackingEventSource(const std::string                &eventSource,
                                                                 const std::vector<unsigned char> &extraData);
    DLL_PUBLIC void SetTrackingProxy(const std::string &proxyHost, uint16_t proxyPort, const std::string &proxyUser,
                                     const std::string &proxyPass);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithImageRawTemplate(
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &rawTemplateBufferTarget,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithImageRawTemplate(
        const std::vector<unsigned char> &imageBufferQuery, const std::vector<unsigned char> &rawTemplateBufferTarget,
        const std::vector<unsigned char> &extraData, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithRawTemplates(
        const std::vector<unsigned char> &rawTemplateBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDVerifierResult VerifySelphIDWithRawTemplates(
        const std::vector<unsigned char> &rawTemplateBufferQuery,
        const std::vector<unsigned char> &rawTemplateBufferTarget, const std::vector<unsigned char> &extraData,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDRawTemplateInfo GetRawTemplateInfo(const std::vector<unsigned char> &templateBuffer);
 
    DLL_PUBLIC int GetFacialTemplateVersion(const std::vector<unsigned char> &facialTemplateBuffer) const;
 
    DLL_PUBLIC SelphIDFacialLivenessResult
    EvaluatePassiveLivenesWithImageBuffer(const std::vector<unsigned char> &imageBuffer);
 
    DLL_PUBLIC SelphIDFacialLivenessResult EvaluatePassiveLivenesWithImageBuffer(
        const std::vector<unsigned char> &imageBuffer, const std::vector<unsigned char> &extraData);
 
    DLL_PUBLIC SelphIDFacialLivenessResult EvaluatePassiveLivenessWithTokenBuffer(
        const std::vector<unsigned char> &tokenBuffer, const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC SelphIDFacialLivenessResult EvaluatePassiveLivenessWithTokenBuffer(
        const std::vector<unsigned char> &tokenBuffer, const std::vector<unsigned char> &extraData,
        const SelphIDVerifierOptions &verifierOptions);
 
    DLL_PUBLIC void SetMultitenantMode(bool multiTenant);
 
    DLL_PUBLIC bool IsMultitenantEnabled();
 
    DLL_PUBLIC std::string GetDebugPath();
 
    DLL_PUBLIC bool IsSDKAlive() const;
 
    DLL_PUBLIC void DoUndocumentedAction(uint16_t actionCode, void *data);
};
 
}    // namespace FPhiSelphID
 
#endif