Using ID Scans
Usage
An ID Scan is a proprietary, tamper-proof payload created and encrypted by the Device SDK. Your App sends the ID Scan payload up to your Server, where the FaceTec Server verifies that the front and back images contain the entire ID Document. If part of the document is obstructed, a retry request is sent to the User. If the ID Scan was captured from a digital computer screen, instead of a physical document, it will be flagged as "Likely Spoof."
The following FaceTec HTTPS API calls require an ID Scan:
Example: Retrieving an ID Scan
An ID Scan is retrieved by accessing it from sessionResult in processIDScanWhileFaceTecSDKWaits(idScanResult, idScanResultCallback). An example of this can be seen in the Sample App's PhotoIDMatchProcessor.
Android SDK (Part 10 of PhotoIDMatchProcessor):
JSONObject parameters = new JSONObject();
try {
parameters.put("externalDatabaseRefID", sampleAppActivity.getLatestExternalDatabaseRefID());
parameters.put("idScan", idScanResult.getIDScanBase64());
parameters.put("minMatchLevel", minMatchLevel);
...
}iOS SDK (Part 12 of PhotoIDMatchProcessor):
var parameters: [String : Any] = [:]
parameters["idScan"] = idScanResult.idScanBase64Browser SDK (Part 12 of PhotoIDMatchProcessor):
var parameters = {
idScan: idScanResult.idScan,
sessionId: idScanResult.sessionId,
externalDatabaseRefID: _this.sampleAppControllerReference.getLatestEnrollmentIdentifier(),
minMatchLevel: MinMatchLevel
};Example: Uploading an ID Scan
An ID Scan is uploaded to the FaceTec Server through an HTTP Post Request. An example of this can be seen in Part 13 of the Sample App's PhotoIDMatchProcessor.
Android SDK:
okhttp3.Request request = new okhttp3.Request.Builder()
.url(Config.BaseURL + "/match-3d-2d-idscan")
.header("Content-Type", "application/json")
.header("X-Device-Key", Config.DeviceKeyIdentifier)
.header("User-Agent", FaceTecSDK.createFaceTecAPIUserAgentString(idScanResult.getSessionId()))
.header("X-User-Agent", FaceTecSDK.createFaceTecAPIUserAgentString(idScanResult.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);
idScanResultCallback.uploadProgress(uploadProgressPercent);
}
}))
.build()iOS SDK:
let request = NSMutableURLRequest(url: NSURL(string: Config.BaseURL + "/match-3d-2d-idscan")! 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((idScanResult.sessionId)!), forHTTPHeaderField: "User-Agent")
request.addValue(FaceTec.sdk.createFaceTecAPIUserAgentString((idScanResult.sessionId)!), forHTTPHeaderField: "X-User-Agent")Browser SDK:
_this.latestNetworkRequest = new XMLHttpRequest();
_this.latestNetworkRequest.open("POST", Config.BaseURL + "/match-3d-2d-idscan");
_this.latestNetworkRequest.setRequestHeader("Content-Type", "application/json");
_this.latestNetworkRequest.setRequestHeader("X-Device-Key", Config.DeviceKeyIdentifier);
_this.latestNetworkRequest.setRequestHeader("X-User-Agent",
FaceTecSDK.createFaceTecAPIUserAgentString(idScanResult.sessionId));Example: Processing an ID Scan for Matching (Custom Server)
An IDScanRequest can be retrieved on the Custom Server by using RequestParsingHelpers's getIDScanRequestOrSendError function. The IDScanRequest can then be processed for matching by passing it as an argument to FaceTecInstanceManager.FaceTecSDKInstance's match3D_2D_idScan function. The response can then be recorded in Match3D2DIDScanResponse.
IDScanRequest idScanRequest = RequestParsingHelpers.getIDScanRequestOrSendError(httpExchange, requestJSON, metadata);
FaceTecMatchLevel minMatchLevel =
FaceTecCoreAPIHelpers.MatchLevelFromInt(RequestParsingHelpers.getIntPropertyFromRequestOrSendError
(httpExchange, requestJSON, "minMatchLevel"));
FaceTecMatch3D2DIDScanResult match3D2DIDScanResult =
FaceTecInstanceManager.FaceTecSDKInstance.match3D_2D_idScan(enrollmentRecord.faceMapWrapper.bytes,
idScanRequest.idScan.bytes, minMatchLevel);
Match3D2DIDScanResponse match3D2DIDScanResponse = new Match3D2DIDScanResponse(metadata,
additionalSessionData, externalDatabaseRefID, match3D2DIDScanResult);Redacting Fields
Developers can choose which fields they would like to redact for ID Scans. To learn how to redact fields, see ID Scan - Redacting Fields.
ID Scan: Advanced Behavior Customization
To customize the logic and behavior of FaceTec's ID Scans, the proper Retry & Rejection Modifier or Logic Flow Modifier will need to be used. There are two viable methods for applying these modifiers to FaceTec's ID Scans:
- Updating the FaceTec Server's config.yaml (FaceTec Standard/Custom Server (v9))
- Updating the FaceTec Server's Java Classes (FaceTec Custom Server (v9) only)
For more information customizing the logic and behavior of FaceTec's ID Scans, please see ID Scan: Logic Behavior & Customization.