This section contains "old" documentation on Android and iOS SDK.

Retrofit API

SDK contains IOzForensicsAPI interface describing APO net calls that can be used to create a Retrofit instance.

This interface uses a gson-converter and operates classes from the com.ozforensics.liveness.sdk.api.model pack.

Apart from this, the interface specifies a static method for creating a default Retrofit instance (without logging, interceptors and with 15-second timeouts). This instance will look for the server at the specified address:

val apiService = OzForensicsAPI.create(BASE_URL)

OzForensicsAPI apiService = OzForensicsAPI.Factory.create(BASE_URL);

OzForensicsService Class

SDK includes the OzForensicsService class that uses a Retrofit instance from OzForensicsAPI.create(). This class wraps in net calls from the Retrofit interface and checks the presence of a token. When an auth request is performed, the token is stored automatically for internal goals. Also, the required metadata is added where necessary when performing the net requests (creating a folder, uploading media data to be analyzed). The method calls of this class are asynchronous (the StatusListener<> interface is used). You can obtain an instance of this class as follows:

val service = OzForensicsService(BASE_URL, ACCESS_TOKEN)

OzForensicsService service = OzForensicsService(BASE_URL, ACCESS_TOKEN);

If the TOKEN parameter value is set to null, authorization is required before performing any API call (except auth):

service.auth(EMAIL, PASSWORD, listener)

service.auth(EMAIL, PASSWORD, listener);

After a successful request, onSuccessCallback is performed so that the access token can be transferred with AuthResponse.

Server-Based Analyzes

Data to be uploaded and analyzed are stored in object results (see above), obtained after capturing and recording video. Upload it to the server and initiate the necessary analyses with the help of Oz API.

A simple scenario of interaction with Oz API can be implemented with the OZSDK.analyse method as described below.

OZSDK.analyse(
  results: results,
    analyseStates: [.quality],
    fileUploadProgress: { (progress) in

    }
) { (resolution, error) in

}

The completion | resolution block will contain the result of the assigned analysis including status (status of the analysis), type (type of the analysis), and folderID (ID of the Oz API folder).

To perform a cross-functional analysis based on video and document photos, use the OZSDK.documentAnalyse method:

OZSDK.documentAnalyse(
  documentPhoto: DocumentPhoto(front: frontDocumentURL, back: backDocumentURL),
  results: results,
  scenarioState: { (state) in
  
  }, fileUploadProgress: { (progress) in

  }
) { (folderResolutionStatus, resolutions, error)

}

The completion | resolution block will contain the result of the assigned analysis (similar to OZSDK.analyse), where folderResolutionStatus is the general status of analyses for the folder.

For both documents and face check, you can use the OZSDK.uploadAndAnalyse method:

OZSDK.uploadAndAnalyse(results: results,
                    documentPhoto: DocumentPhoto(front: frontDocumentURL, back: backDocumentURL),
                    analysisTypes: [.quality],
                    metadata: nil,
                    scenarioState: { state in },
                    fileUploadProgress: { progress in }) { status, resolution, error in }) 

The resolution block will contain the result of the assigned analysis (similar to OZSDK.analyse and OZSDK.documentAnalyse).

On-Device Analyzes

The methods below are used to analyze media on the device.

Biometry:

OZSDK.runOnDeviceBiometryAnalysis(firstResult: firstResult, secondResult: secondResult, completion: { status, error in
//show result
})

Liveness:

OZSDK.runOnDeviceLivenessAnalysis(results: results, completion: {status, error in 
//show result
})

Server-Based Analyzes

Data to be uploaded and analyzed is stored in object sdkMediaResult, obtained after capturing and recording video. Upload it to the server and initiate required analyses via .

A simple scenario of interaction with Oz API can be implemented with theuploadMediaAndAnalyze method as described below.

On-Device Analyzes

To run the on-device analyses instead of server-based, use the following methods: