Liveness Detection iOS SDK

Face Liveness Detection iOS SDK

Code

Setup

  1. Copy facesdk.frameworkdirectory to the root folder of your project.

  2. Add SDK framework to the project in Xcode

  3. Add FaceDemo-Bridging-Header.h to Build Settings

APIs

setActivation: This API is used to activate the SDK

+(int)setActivation:(NSString*)license;

Input

  • license (NSString*): The license string

Return value

The SDK activation status code.

  • 0: Success

  • Non-zero: Activation failed

initSDK: This API is used to initialize the SDK

+(int)initSDK;

Input

None

Return value

The SDK initialization status code.

  • 0: Success

  • -1: License Key Error

  • -2: License AppID Error

  • -3: License Expired

  • -4: Activate Error

  • -5: Initialize SDK Error

faceDetection: This API is used to detect faces and determine if the faces are real or fake

+(NSMutableArray*)faceDetection:(UIImage*)image;

Input

  • image (UIImage*): The input image

Return value

An array of FaceBox objects representing the detected faces and their liveness scores.

FaceBox

@interface FaceBox : NSObject

@property (nonatomic) int x1;
@property (nonatomic) int y1;
@property (nonatomic) int x2;
@property (nonatomic) int y2;
@property (nonatomic) float liveness;
@property (nonatomic) float yaw;
@property (nonatomic) float roll;
@property (nonatomic) float pitch;
@end

The liveness score ranges from 0.0 to 1.0

If it's greater than the threshold, it's real face

Last updated