Python EKYC API

oneML module to run ekyc pipeline.

oneML.faceAPI.EKYCOps : public object

Operations on EKYC input image.

Public Functions

__init__(self, *args)

Construct an EKYCOps object.

args:

Parameters

  • args: Variable length argument list.

  • blur_check bool. (required, whether to run blur check)

  • face_blur_check bool. (required, whether to run face blur check)

  • pad_check bool. (required, whether to run digital and paper pad checks)

  • pose_check bool. (required, whether to run face pose check)

oneML.faceAPI.EKYC : public object

The oneML EKYC API object. 

Class to create and use oneML EKYC module.

Public Functions

__init__(self, *args)

Construct an EKYC object. 

    args:

    - FaceDetector instance. (optional)
    - FaceEmbedder instance. (optional)
    - LicenseManager instance
Parameters

  • args: Variable length argument list.

run(self, imgvec1_, imgvec2_, image1_ops, image2_ops, same_person_dist_threshold=- 1.0)

Run EKYC pipeline.

Return

EKYCResult: result object

Parameters

  • imgvec1_: image1 numpy array with shape (height, width, channel)

  • imgvec2_: image2 numpy array with shape (height, width, channel)

  • image1_ops: EKYCOps for image1

  • image2_ops: EKYCOps for image2

  • same_person_dist_threshold: same person distance threshold, -1.0 means default threshould

oneML.faceAPI.EKYCResult : public object

The result object for oneML EKYC API. 

Helper class to access all the results from
an API call.

Public Functions

get_distance(self)

Get distance between image1 and image2.

Return

float

is_same_person(self)

Return whether the two input images are the same person.

Return

bool

get_return_status(self)

Get return status.

Return

int: return status

get_face_poses(self)

Get the image1 and image2 cropped face Pose values.

Return

IntVector: list of int values of Pose enumerators

get_landmarks(self)

Get the image1 and image2 cropped face FaceLandmark5 objects.

Return

Landmarks5Vector: list of Landmark5 objects

get_bboxes(self)

Get the image1 and image2 cropped face BBox objects.

Return

BBoxVector: list of BBox objects

get_bbox_scores(self)

Get the image1 and image2 cropped face BBox scores.

Return

FloatVector: list of scores 

List of EKYCResult objects.
oneML.faceAPI.EKYCStatus_Empty = _oneMLfacePython.EKYCStatus_Empty
oneML.faceAPI.EKYCStatus_Success = _oneMLfacePython.EKYCStatus_Success
oneML.faceAPI.EKYCStatus_ImageBlurCheckFail = _oneMLfacePython.EKYCStatus_ImageBlurCheckFail
oneML.faceAPI.EKYCStatus_DigitalPadFail = _oneMLfacePython.EKYCStatus_DigitalPadFail
oneML.faceAPI.EKYCStatus_PaperPadFail = _oneMLfacePython.EKYCStatus_PaperPadFail
oneML.faceAPI.EKYCStatus_NoFaceFound = _oneMLfacePython.EKYCStatus_NoFaceFound
oneML.faceAPI.EKYCStatus_FaceBlurCheckFail = _oneMLfacePython.EKYCStatus_FaceBlurCheckFail
oneML.faceAPI.EKYCStatus_FaceNotFrontal = _oneMLfacePython.EKYCStatus_FaceNotFrontal