Using 3D FaceScans
Usage
A 3D FaceScan is an encrypted byte blob that contains reverse engineered 3D data from 100+ video frames captured during a User's session. A FaceScan is generated by the Device SDK and uploaded to the FaceTec Server where it can then be processed. The FaceScan itself contains both Liveness AND Matching data. To avoid a honeypot risk, the FaceScan is converted to a FaceMap, which does not contain Liveness Data. This FaceMap is then stored in Your Database to be used later for 3D:3D and 3D:2D matching.
The following FaceTec HTTPS API calls require a FaceScan:
Example: Retrieving a FaceScan
A FaceScan is retrieved by accessing it from sessionResult in processSessionWhileFaceTecSDKWaits(sessionResult, faceScanResultCallback). An example of this can be seen in Part 2 of the Sample App's LivenessCheckProcessor.
Android SDK:
JSONObject parameters = new JSONObject();
try {
parameters.put("faceScan", sessionResult.getFaceScanBase64());
parameters.put("auditTrailImage", sessionResult.getAuditTrailCompressedBase64()[0]);
parameters.put("lowQualityAuditTrailImage", sessionResult.getLowQualityAuditTrailCompressedBase64()[0]);
}iOS SDK:
var parameters: [String : Any] = [:]
parameters["faceScan"] = sessionResult.faceScanBase64Browser SDK:
var parameters = {
faceScan: sessionResult.faceScan,
auditTrailImage: sessionResult.auditTrail[0],
lowQualityAuditTrailImage: sessionResult.lowQualityAuditTrail[0],
sessionId: sessionResult.sessionId
};Example: Uploading a FaceScan
A FaceScan is uploaded to the FaceTec Server through an HTTP Post Request. An example of this can be seen in part 5 of the Sample App's LivenessCheckProcessor.
Android SDK:
okhttp3.Request request = new okhttp3.Request.Builder()
.url(Config.BaseURL + "/liveness-3d")
.header("Content-Type", "application/json")
.header("X-Device-Key", Config.DeviceKeyIdentifier)
.header("User-Agent", FaceTecSDK.createFaceTecAPIUserAgentString(sessionResult.getSessionId()))
.header("X-User-Agent", FaceTecSDK.createFaceTecAPIUserAgentString(sessionResult.getSessionId()))
.post(new ProgressRequestBody(RequestBody.create(MediaType.parse("application/json; charset=utf-8"), parameters.toString()),
new ProgressRequestBody.Listener() {
@Override
public void onUploadProgressChanged(long bytesWritten, long totalBytes) {
final float uploadProgressPercent = ((float)bytesWritten) / ((float)totalBytes);
faceScanResultCallback.uploadProgress(uploadProgressPercent);
}
}))
.build();iOS SDK:
var request = URLRequest(url: NSURL(string: Config.BaseURL + "/liveness-3d")! as URL)
request.httpMethod = "POST"
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try! JSONSerialization.data(withJSONObject: parameters, options: JSONSerialization.WritingOptions(rawValue: 0))
request.addValue(Config.DeviceKeyIdentifier, forHTTPHeaderField: "X-Device-Key")
request.addValue(FaceTec.sdk.createFaceTecAPIUserAgentString(sessionResult.sessionId), forHTTPHeaderField: "User-Agent")
request.addValue(FaceTec.sdk.createFaceTecAPIUserAgentString(sessionResult.sessionId), forHTTPHeaderField: "X-User-Agent")Browser SDK:
this.latestNetworkRequest = new XMLHttpRequest();
this.latestNetworkRequest.open("POST", Config.BaseURL + "/liveness-3d");
this.latestNetworkRequest.setRequestHeader("Content-Type", "application/json");
this.latestNetworkRequest.setRequestHeader("X-Device-Key", Config.DeviceKeyIdentifier);
this.latestNetworkRequest.setRequestHeader("X-User-Agent", FaceTecSDK.createFaceTecAPIUserAgentString(sessionResult.sessionId as string));
Example: Processing a FaceScan to Verify Liveness (Custom Server)
A FaceScanRequest can be retrieved on the Custom Server by using RequestParsingHelpers's getFaceScanRequestOrSendError function. The FaceScanRequest can then be processed for a Liveness Check by passing it as an argument to the FaceTecCoreAPIHelpers's Liveness3D function.
FaceScanRequest faceScanRequest = RequestParsingHelpers.getFaceScanRequestOrSendError(httpExchange, requestJSON, metadata);
FaceTecLiveness3DResult livenessResult = FaceTecCoreAPIHelpers.Liveness3D(faceScanRequest);