Android v2.1.x UI Only

TrustVisionSDK.init(jsonConfigurationByServer, languageCode);

app
root
repo
    +--com
    +--trustvision
    +--tv_api_sdk
    +--2.x.x
        +--tv_api_sdk-2.x.x.aar
        +--tv_api_sdk-2.x.x.pom
    maven-metadata.xml
    +--tv_core_sdk
    +--tv_sdk
...

repositories {
    maven { url "https://maven.google.com" }
    maven { url "https://jitpack.io" } // from SDK v2.0.0.20 and above
    maven { url "path/to/tvsdk/folder" }
    ...
}

android {
    ...
    aaptOptions {
        noCompress "tflite"
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation('com.trustvision:tv_sdk:2.x.x@aar') {
        transitive = true
    }
    testImplementation 'junit:junit:4.12'

}

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    TrustVisionSDK.init(jsonConfigurationByServer, languageCode);
}

TrustVisionSdk.getSupportedLanguages();

TrustVisionSdk.getLanguageCode();

TrustVisionSdk.changeLanguageCode(String languageCode);

TVIDConfiguration.Builder builder = new TVIDConfiguration.Builder()
    .setCardType(selectedCard)
    .setCardSide(TVSDKConfiguration.TVCardSide.FRONT)
    .setReadBothSide(false)
    .setEnableSound(false)
    .setEnablePhotoGalleryPicker(false)
    .setEnableTiltChecking(false)
    .setSkipConfirmScreen(false);

TVIDConfiguration configuration = builder.build();

TrustVisionSDK.startIDCapturing(context, configuration, new TVIDCapturingCallBack() {
    @Override
    public void onNewFrameBatch(FrameBatch frameBatch) {

    }

    @Override
    public void onError(TVDetectionError error) {

    }

    @Override
    public void onSuccess(TVDetectionResult result) {

    }

    @Override
    public void onCanceled() {

    }
});

// this dictionary will be used for ID Tampering Verification
Map frontCardFrameBatchIdsDictionary = new HashMap<String, String>();
Map backCardFrameBatchIdsDictionary = new HashMap<String, String>();
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// );

@Override
public void onNewFrameBatch(FrameBatch frameBatch) {
    Gson gson = new Gson();
    String framesStr = gson.toJson(frameBatch.getFrames());
    Map<String, Object> params = new HashMap<>();
    params.put("frames", framesStr);
    params.put("metadata", frameBatch.getMetadata());
    params.put("label", "video");

    String jsonToBeUploaded = gson.toJson(params);
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    YourResponseObject uploadingResult = yourMethodToUploadFrameBatch(jsonToBeUploaded);

    // Keep the id that generated by the SDK corresponding with the one responded from server
    if (cardSide == TVSDKConfiguration.TVCardSide.FRONT) {
        frontCardFrameBatchIdsDictionary.put(
            key = frameBatch.batchId,
            value = uploadingResult.fileId
        );
    } else {
        backCardFrameBatchIdsDictionary.put(
            key = frameBatch.batchId,
            value = uploadingResult.fileId
        );
    }
}

// These lists contain all valid frame batch ids that responded by server
List<String> validFrontCardServerFrameBatchIds;
List<String> validBackCardServerFrameBatchIds;

@Override
public void onSuccess(TVDetectionResult result) {
    // result.livenessFrameBatchIds is null when Frame Recording feature is disabled by client settings.
    // Wait until every Frame batch has been uploaded to server before calling this
    if(everyFrameBatchUploadingCompleted) {
        if(result.frontCardFrameBatchIds != null) {
            validFrontCardServerFrameBatchIds = removeRedudantFrameBatchIds(frontCardFrameBatchIdsDictionary, result.frontCardFrameBatchIds);
        }
        if(result.backCardFrameBatchIds != null) {
            validBackCardServerFrameBatchIds = removeRedudantFrameBatchIds(backCardFrameBatchIdsDictionary, result.backCardFrameBatchIds);
        }
    }
}

private List<String> removeRedudantFrameBatchIds(Map<String, String> batchIdsDictionary, Set<String> validIdsFromSDK) {
    Iterator<Map.Entry<String, String>> iter = batchIdsDictionary.entrySet().iterator();
    while(iter.hasNext()) {
        Map.Entry<String, String> entry = iter.next();
        if(!validIdsFromSDK.contains(entry.getKey())) {
            iter.remove();
        }
    }

    return batchIdsDictionary.values();
}

String frontCardId;
String backCardId;
String qrId;

@Override
public void onSuccess(TVDetectionResult result) {
    ByteArrayOutputStream stream = new ByteArrayOutputStream();
    // With front side
    if (result.getFrontCardImage() && result.getFrontCardImage().getImage() != null) {
        // 100 quality is required
        result.getFrontCardImage().getImage().compress(Bitmap.CompressFormat.JPEG, 100, stream);
        byte[] dataToUpload = stream.toByteArray();
        frontCardId = yourMethodToUploadImage(dataToUpload);
    }

    // With back side
    if (result.getBackCardImage() && result.getBackCardImage().getImage() != null) {
        // 100 quality is required
        result.getBackCardImage().getImage().compress(Bitmap.CompressFormat.JPEG, 100, stream);
        byte[] dataToUpload = stream.toByteArray();
        backCardId = yourMethodToUploadImage(dataToUpload);
    }

    // With QR image (Available from v2.0.6.9)
    // In case the QR capturing feature is enabled, and `result.getCardQrImage()` is null then
    // the user will be notified so they can choose to re-capture their ID card.
    if (result.getCardQrImage() && result.getCardQrImage().getImage() != null) {
        // 100 quality is required
        result.getCardQrImage().getImage().compress(Bitmap.CompressFormat.JPEG, 100, stream);
        byte[] dataToUpload = stream.toByteArray();
        qrId = yourMethodToUploadImage(dataToUpload);
    }
}

{
  "file": "<byte[] dataToUpload>",
  "label": "<proper label, check the API document for detail>"
}

{
    "image": {
        "id": "<frontCardId>"
    },
     "image2": {
        "id": "<backCardId>"
    },
    "qr1_images": [{
        "id": "<qrId>"
    }],
    "card_type": "<result.cardType.getCardId()>",
    "videos": [{
          "id": "<validFrontCardServerFrameBatchIds.get(index)>"
      },
      {
          "id": "<validFrontCardServerFrameBatchIds.get(index + 1)>"
      },
      ...
      {
          "id": "<validBackCardServerFrameBatchIds.get(index)>"
      },
      {
          "id": "<validBackCardServerFrameBatchIds.get(index + 1)>"
      },
      ...
    ]
}

val data : ByteArray = convertBitmapToByteArray(tvDetectionResult.cardQrImage?.image)
val metadata : String = tvDetectionResult.cardQrImage?.metaData
val label : String = tvDetectionResult.cardQrImage?.label

TVSelfieConfiguration.Builder builder = new TVSelfieConfiguration.Builder()
    .setCameraOption(TVSDKConfiguration.TVCameraOption.FRONT)
    .setEnableSound(false)
    .setLivenessMode(TVLivenessMode.PASSIVE)
    .setSkipConfirmScreen(false);

TrustVisionSDK.startSelfieCapturing(context, languageCode, builder.build(), new TVCapturingCallBack() {
    @Override
    public void onNewFrameBatch(FrameBatch frameBatch) {

    }

    @Override
    public void onError(TVDetectionError error) {

    }

    @Override
    public void onSuccess(TVDetectionResult result) {

    }

    @Override
    public void onCanceled() {

    }
});

// this dictionary will be used for Liveness verification
Map selfieFrameBatchIdsDictionary = new HashMap<String, String>();
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// );

@Override
public void onNewFrameBatch(FrameBatch frameBatch) {
    Gson gson = new Gson();
    String framesStr = gson.toJson(frameBatch.getFrames());
    Map<String, Object> params = new HashMap<>();
    params.put("frames", framesStr);
    params.put("metadata", frameBatch.getMetadata());
    params.put("label", "video");

    String jsonToBeUploaded = gson.toJson(params);
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    YourResponseObject uploadingResult = yourMethodToUploadFrameBatch(jsonToBeUploaded);

    // Keep the id that generated by the SDK corresponding with the one responded from server
    frameBatchIdsDictionary.put(
        key = frameBatch.batchId,
        value = uploadingResult.fileId
    );
}

// This list contains all valid frame batch ids that responded by server
List<String> validServerFrameBatchIds;

@Override
public void onSuccess(TVDetectionResult result) {
    // result.livenessFrameBatchIds is null when Frame Recording feature is disabled by client settings.
    // Wait until every Frame batch has been uploaded to server before calling this
    if(everyFrameBatchUploadingCompleted) {
        if(result.livenessFrameBatchIds != null) {
            validServerFrameBatchIds = removeRedudantFrameBatchIds(selfieFrameBatchIdsDictionary, result.livenessFrameBatchIds);
        }
    }
}

private List<String> removeRedudantFrameBatchIds(Map<String, String> batchIdsDictionary, Set<String> validIdsFromSDK) {
    Iterator<Map.Entry<String, String>> iter = batchIdsDictionary.entrySet().iterator();
    while(iter.hasNext()){
        Map.Entry<String, String> entry = iter.next();
        if(!validIdsFromSDK.contains(entry.getKey())) {
            iter.remove();
        }
    }

    return batchIdsDictionary.values();
}

// These lists of image ids will be used in Liveness Verification
List<String> frontalImageIds = new ArrayList<>();
List<String> gestureImageIds = new ArrayList<>();

@Override
public void onSuccess(TVDetectionResult result) {
    handleSelfieImages(result.getSelfieImages());
}

private void handleSelfieImages(List<SelfieImage> selfieImages) {
    for(selfieImage: selfieImages) {
        // Handle frontal images
        if(selfieImage.getFrontalImage() != null && selfieImage.getFrontalImage().getImage() != null) {
            ByteArrayOutputStream stream = new ByteArrayOutputStream();
            // 100 quality is required
            selfieImage.getFrontalImage().getImage().compress(Bitmap.CompressFormat.JPEG, 100, stream);
            byte[] frontalImageByteArray = stream.toByteArray();
            // frontalImageId is the id of the image, returned from server when the uploading API is completed successfully
            String frontalImageId = yourUploadImageMethod(frontalImageByteArray);
            frontalImageIds.add(frontalImageId);
        }

        // Handle gesture images
        if(selfieImage.getGestureImage() != null && selfieImage.getGestureImage().getImage()!=null) {
            ByteArrayOutputStream stream = new ByteArrayOutputStream();
            // 100 quality is required
            selfieImage.getGestureImage().getImage().compress(Bitmap.CompressFormat.JPEG, 100, stream);
            byte[] gestureImageByteArray = stream.toByteArray();
            // gestureImageId is the id of the image, returned from server when the uploading API is completed successfully
            String gestureImageId = yourUploadImageMethod(gestureImageByteArry);
            gestureImageIds.add(gestureImageId);
        }
    }
}

{
  "file": "<byte[] dataToUpload>",
  "label": "<proper label, check the API document for detail>"
}

{
  "images": [
    {
      "id": "<frontalImageIds.get(index)>"
    },
    {
      "id": "<frontalImageIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "gesture_images": [
    {
      "gesture": "<result.getSelfieImages().get(index).getGestureType().toGestureType().toLowerCase()>",
      "images": [{
          "id": "<gestureImageIds.get(index)>"
      }]
    },
    {
      "gesture": "<result.getSelfieImages().get(index + 1).getGestureType().toGestureType().toLowerCase()>",
      "images": [{
        "id": "<gestureImageIds.get(index + 1)>"
      }]
    },
    ...
  ]
}

{
  "videos": [
    {
      "id": "<validServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validServerFrameBatchIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "metadata": "<result.getLivenessMetadata()>"
}

// [FlowStartingFunc]: startIdCapturing, startSelfieCapturing

TrustVisionSDK.[FlowStartingFunc](..., builder.build(), new TVCapturingCallBack() {
    @Override
    public void onError(TVDetectionError error) {
        String message = error.getErrorDescription();
        Log.d("", message);
        showToast(message);

        ///////////////////////////////////////
        // ERROR HANDLER
        int code = error.getErrorCode();
        String description = error.getErrorDescription();

        switch code {
          case TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING:
          // No camera permission.
          case TVDetectionError.DETECTION_ERROR_CAMERA_ERROR:
          // The camera can't be opened.
          case TVDetectionError.DETECTION_ERROR_SDK_INTERNAL:
          // The SDK has an unexpected error.
        }
    }

    @Override
    public void onSuccess(TVDetectionResult result) {

    }
});

int NEUTRAL = 1
int TURN_LEFT = 5
int TURN_RIGHT = 6
int FACE_UP = 7
int FACE_DOWN = 8

int TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING = 1004
int TVDetectionError.DETECTION_ERROR_CAMERA_ERROR = 1005
int TVDetectionError.DETECTION_ERROR_SDK_INTERNAL = 1007