C# EKYC API

oneML module to run ekyc pipeline.

OneML.Face.EKYCOps : public global.SystemIDisposable

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

inline EKYCOps(bool blur_check, bool face_blur_check, bool pad_check, bool pose_check)

Construct an EKYCOps object.

Parameters

  • blur_check: whether to run blur check.

  • face_blur_check: whether to run face blur check.

  • pad_check: whether to run digital and paper pad checks.

  • pose_check: whether to run face pose check.

OneML.Face.EKYC : public global.SystemIDisposable

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

inline EKYC(LicenseManager manager)

Construct an EKYC object.

Parameters

  • manager: LicenseManager.

inline EKYC(FaceDetector face_detector, FaceEmbedder face_embedder, LicenseManager manager)

Construct an EKYC object.

Parameters

  • face_detector: FaceDetector.

  • face_embedder: FaceEmbedder.

  • manager: LicenseManager.

inline EKYC(FaceEmbedder face_embedder, LicenseManager manager)

Construct an EKYC object.

Parameters

  • face_embedder: FaceEmbedder.

  • manager: LicenseManager.

inline EKYC(FaceDetector face_detector, LicenseManager manager)

Construct an EKYC object.

Parameters

  • face_detector: FaceDetector.

  • manager: LicenseManager.

inline EKYCResult Run(Image image1, Image image2, EKYCOps image1_ops, EKYCOps image2_ops)

Run EKYC pipeline.

Return

an instance of EKYCResult.

Parameters

  • image1: image1, an instance of Image.

  • image2: image2, an instance of Image.

  • image1_ops: EKYCOps for image1.

  • image2_ops: EKYCOps for image2.

inline EKYCResult Run(Image image1, Image image2, EKYCOps image1_ops, EKYCOps image2_ops, float same_person_dist_threshold)

Run EKYC pipeline.

Return

an instance of EKYCResult.

Parameters

  • image1: image1, an instance of Image.

  • image2: image2, an instance of Image.

  • image1_ops: EKYCOps for image1.

  • image2_ops: EKYCOps for image2.

  • same_person_dist_threshold: same person distance threshold

OneML.Face.EKYCResult : public global.SystemIDisposable

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

inline float GetDistance()

Get distance between image1 and image2.

Return

float

inline bool IsSamePerson()

Return whether the two input images are the same person.

Return

bool

inline int GetReturnStatus()

Get return status.

Return

int

inline BBoxList GetBBoxes()

Get the image1 and image2 cropped face BBox objects.

Return

an instance of BBoxList.

inline FloatList GetBBoxScores()

Get the image1 and image2 cropped face BBox scores.

Return

an instance of FloatList.

inline Landmark5List GetLandmarks()

Get the image1 and image2 cropped face FaceLandmark5 objects.

Return

an instance of Landmark5List.

inline FacePoseList GetFacePoses()

Get the image1 and image2 cropped face Pose values.

Return

an instance of FacePostList.

Enums

enum EKYCStatus

Values:

enumerator Empty
enumerator Success
enumerator ImageBlurCheckFail
enumerator DigitalPadFail
enumerator PaperPadFail
enumerator NoFaceFound
enumerator FaceBlurCheckFail
enumerator FaceNotFrontal