mosip-mobileid-sdk-test
v0.0.8
Published
mosip face matching sdk for inji
Maintainers
Readme
Mosip Mobileid sdk
- This is a react native component library created to perform authentication in inji app.
- The library uses FaceAuthProps which takes data as input and provides onValidationSuccess() function which can be called after validation is successful.
- It opens camera and captures face image. It compares face image with the input data and on successful match it triggers onValidationSuccess() function.
- To find match it uses AuthenticationService.ts file. (The matching function is mocked right now)
export interface FaceAuthProps {
data:string;
onValidationSuccess: () => void;
};- Refer to the example folder to check usage of the library.
USAGE
- Using npm -
npm install mosip-mobileid-sdk- Using yarn -
yarn add mosip-mobileid-sdkLatest stable version
"1.0.9"API SPEC
The sdk will be used by INJI app for biometric authentication. An SDK system that integrates with MOSIP should support the following operations.
Parameters
Name | Description | Type -----|-------------|-------------- capturedImage | The image that is captured by the sdk camera | string vcImage | The image present inside credential that is passed to the sdk as input for authentication | string
Standard Return Codes(match or no match)
response | Status -----|--------- true | Success false | Failed
FaceMatching
Signature
function authenticateFace(capturedImage: CameraCapturedPicture|null, vcImage:string): boolean {
// face matching algorithm logic here
return boolean;
}