Android Component SDK

The Assentify Component SDK has several capabilities and functionalities that empower developers to take complete control of the identity extraction process. The Component SDK complements the Digital Experience Platform (DXP).

The developer leverages the available data by using the response information from the supported components or data provided by the app user. The SDK allows the developer to submit all extracted data to Assentify to gain access to further features such as Compliance, AML, client profile, and other capabilities that the DXP covers. The key components supported and available in the SDK are the identification document capture, face capture and matching, Context-Aware-Signing, wrap up, and submission.

The Assentify Component SDK is available for Android native, iOS native, Flutter, and React Native. To use the Android SDK you need the following before you begin.

• An Assentify DXP account with access to the Developers section of the portal.
• An API Key, a Tenant Identifier, and an Interaction Hash retrieved from the portal (see Getting credentials).
• A published flow with the Engagement block and Steps you intend to target.

The guide describes the project files you update to enable NFC passport scanning. As part of Step 6 of that capability, you update the AndroidManifest and app/build.gradle. For the package coordinates and repository, follow the version your Assentify contact provides.

To leverage the capabilities of the Assentify Component SDK, the developer must initialize the SDK on each application start up. Initialization ensures the developer has the key information required to begin using the Component SDK. To initialize the Component SDK you will require the following variables.

• API Key
• Tenant Identifier
• Interaction Hash

The values for the above variables can be retrieved from the Assentify DXP portal. Once you have logged in, visit the Developers section and select the Flow you would like to use for your application.

1. environmentalConditions configuration

The variable environmentalConditions is instantiated as an object of type EnvironmentalConditions. It is configured with the following parameters.

2. assentifySdk configuration

The assentifySdk object is an instance of AssentifySdk and is initialized with several parameters.

Initialization callbacks

Retrieve the API Key, Tenant Identifier, and Interaction Hash from the Assentify DXP portal.

1. Visit the Assentify DXP and click on the Developers section. Then click on the Flow Configuration button.
2. Select the flow you want to use with your application. Then, from the drop-down menu, select the Engagement block you would like to target.
3. Once you have selected an appropriate block you will be able to see the information related to the flow. You can retrieve the Tenant Identifier from this section.
4. To retrieve the API Key, create a new API Key or leverage an already existing key. You can assign Claims to an API Key, which you can then use to limit the amount of access a specific API Key has.
5. To fetch the Interaction Hash, click on the Flow Manager and select your flow. Once the Digital Engagement Link has loaded on the right side panel, the format should be https://platform.assentify.com?interaction={HASH}. Copy the HASH part to retrieve the interaction hash.

The Assentify BlockLoader is a core component provided to the developer to perform several functions and capabilities. The BlockLoader provides the developer with core properties that the developer sets to give context to the Assentify DXP platform.

The properties outlined above are built into the BlockLoader. However, the developer can access the DXP and add additional properties if needed. For example, creating additional properties such as phoneNumber and clientIdentifier; these properties can be used to transfer custom information to Assentify DXP, which can later be mapped to WebHooks or other platform capabilities. The developer has no limit on the number of properties that can be added to the BlockLoader.

How to add a property to the BlockLoader

1. Go to the Flow Manager and select the flow you want to edit.
2. Click the view more button on the Engagement Block.
3. In the input field, type the name of the property. Then press the add button.
4. Completed.

How to use the BlockLoader properties as a developer

Once the developer adds these properties using the DXP, the developer then defines in their application the properties that have been added, which they can use to set the BlockLoader Step for Submission. All custom properties added can be used to perform additional capabilities on the Assentify DXP, such as running decisions and mapping webhooks.

To make use of the custom properties added on the Assentify DXP, you need to declare these properties inside your app. Assentify uses OnBoardMe_Property_{propertyName} as the naming nomenclature for all custom properties.

The Identification Document Capture is a standalone event-driven component that provides a means by which the developer can extract information from an ID Card. The ID type is determined by the configuration set in Assentify DXP. The developer or business user can log in to Assentify and manage these configurations at any time, even after the application has gone live. This provides flexibility in allowing the application to support as many ID cards as possible without re-compiling and deploying the application.

This component returns many different types of information depending on the ID Type being scanned, such as a Civil ID versus a Driving License. This is done using dynamic keys and mappings built into the SDK. A global model is available for developers to extract information from the base model and the available property dictionary. The component has a built-in user interface that can be used by default, or the developer can use their own custom user interface by turning off the guides and default interface, and drawing on top of the events fired during the scanning process.

Methods

startFlow parameters

This function initializes and launches the entire flow, including the UI and events configured in the Admin Portal.

FlowEnvironmentalConditions fields:

startScanIDCard parameters

startScanPassport parameters

startScanOther parameters

startScanNfc parameters

How to initialize the flow

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startFlow().
3. Configure the startFlow parameters.

How to initialize the ID Card scanning

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startScanIDCard().
3. Configure the startScanIDCard parameters.
4. startScanIDCard accepts a parameter templatesByCountry that includes all the available templates that are retrieved.

How to initialize the passport scanning

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startScanPassport().
3. Configure the startScanPassport parameters.
4. Completed.

How to initialize NFC passport scanning

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startScanNfc().
3. Check NFC support.
4. Override onResume, onPause, and onNewIntent.
5. Call onActivityNewIntent with the extracted Passport Response Model.
6. Update the AndroidManifest and app/build.gradle.

How to initialize other ID scanning

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startScanOther().
3. Configure the startScanOther parameters.
4. Completed.

The Face Capture and Matching step is a standalone event-driven component that allows the developer to perform face matching between a live source and a target image. The developer offers the target image, while the selfie camera captures the source image. All the features and capabilities of the Face Capture / Matching component are driven by the configuration that the developer or business user can configure on Assentify DXP. The developer may choose to override this configuration.

How to use the Face Acquisition component

1. Initialize the Assentify Sdk Object.
2. Call AssentifySdk.startFaceMatch().
3. Configure the startFaceMatch parameters.
4. Supply the target base-64 encoded face image.
5. Add the component to the fragment manager and commit.
6. Run the application.

How to initialize it

1. Call startContextAwareSigning.
2. Wait for onHasTokens: the tokens from your selected document.
3. Fill the tokens and call createUserDocumentInstance.
4. Wait for onCreateUserDocumentInstance and call the signature function with a base64 signature.
5. Wait for onSignature and get the document URL.

The Wrap Up component is a built-in step that allows the developer to set the TimeEnded value. The developer can supply an end time for the flow.

Submission is a built-in function of the SDK that allows the developer to initiate the data transmission from the integrating app to Assentify DXP. The power of Submission is that it can be used to add additional properties to the BlockLoader and perform data aggregation and manipulation before sending it to Assentify. For example, the developer may want to send additional eKYC information, user-specific data, or data to bridge between the Assentify DXP and the back-end services of the integrating application. The developer may also perform additional functions such as custom date formatting, translation, transliteration, and calculations.

One of the key features of using the Assentify Component SDK is being able to submit all the collected data to Assentify DXP, allowing business users to review all the data that has been collected. The simplest way to submit data to Assentify is to leverage the existing code provided in the Demo Application (Android, iOS).

How to submit data to Assentify DXP

1. Retrieve the step definition model so that there is a reference to the List<StepDefinitions>.
2. Retrieve the output properties model.
3. Retrieve the output properties for the face from OutPropertiesModelFace.
4. Define variables for the wrap up, blockLoader, Context-Aware-Signing step, face step, and ID capture step.
5. Loop through the steps and populate the output properties into a map.
6. Ensure that each SubmitRequestModel is then set into a MutableList<SubmitRequestModel>.
7. Call the assentifySdk.startSubmitData() method.

You must prepare your list of steps with the outputProperties obtained for each step. For example:

sharedStepDefinitionsStepFace = SubmitRequestModel(item.stepId, StepsName.FaceMatch, values);
sharedStepDefinitionsStepDoc  = SubmitRequestModel(item.stepId, StepsName.DocumentCapture, values);
// etc.

Callbacks on the BaseResponseDataModel report progress and results during processing.

A list of LanguageTransformationModel objects is created and populated with different language transformation configurations. Each model specifies the type of language transformation (either translation or transliteration), a key-value pair, the target language, and the data type for that transformation.

The LanguageTransformationModel class defines the structure for each language transformation, requiring the following parameters.

After defining the data, invoke language transformation and handle the callbacks for the transformation results.

BaseResponseDataModel

TemplatesByCountry

KycDocumentDetails

Templates

ConfigModel

StepDefinitions

OutputProperties

Customization

PassportResponseModel

PassportExtractedModel

OtherResponseModel

OtherExtractedModel

IDResponseModel

IDExtractedModel

FaceResponseModel

FaceExtractedModel

IdentificationDocumentCapture

DocumentTokensModel

CreateUserDocumentResponseModel

SignatureResponseModel

Can you set what data the ResponseModels have from the admin page?

No, the response models are static and are based on responses from the core ID orchestrator.

When the onComplete callback is triggered (for example, for the passport), can that data be retrieved or a hook triggered on our backend?

When the callback is triggered, the application receives all the information. It is the responsibility of the application to transfer that data to any specific backend at this point. If the data can be transferred at a later stage, or when it has been submitted to the platform, then yes: you can define a webhook in the connector block to be triggered after submission to inform your backend or send you specific data.

What are the KycDocumentDetails on the ScanIDCard? How would I know how many to add to the list?

The template chosen from the getTemplates() callback.

Are there any actions allowed to be triggered programmatically on the scan screens (ScanIDCard, FaceMatch, etc.)?

For features like ScanIDCard and FaceMatch, these are returned as fragments, allowing you to draw on top of them. For ScanIDCard, you receive each page in order via the onComplete callback. The camera automatically starts scanning the next page after each callback.

On the FaceMatchActivity there is a static document image being loaded to be matched against the face. How can I get the document scanned on the previous step to pass it to the face match?

You can obtain the imageUrl from the onComplete callback for document scanning, convert it to base64, and use it in face match.

What happens if the document had multiple sides? How can I find which document had the photo of the user to pass to the FaceMatch?

You must choose an order (page) that contains a face to set it for face match. When the document URL is retrieved from the document scan, Assentify flags that it has a face extracted based on the template.

What data should you submit on startSubmitData? Are these specified from the admin page?

You must prepare your list of steps with the outputProperties obtained for each step. For example, SubmitRequestModel(item.stepId, StepsName.FaceMatch, values) and SubmitRequestModel(item.stepId, StepsName.DocumentCapture, values).

On the StepNames file there are various keys used for uploading the data on startSubmitData. How do these correlate with the admin page? Where can I find this mapping?

In Flow Builder, after selecting a flow from Flow Manager, you are presented with the various blocks that make up the flow. To view the additional keys per flow, select the magnifier icon on the BlockLoader; you can press the magnifier icon and see all the data there. You can also define and add new data points.