React Native Component SDK

Assentify offers two kinds of SDK. This page documents the Component SDK for React Native.

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 Assentify DXP platform (SaaS). 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 features that the DXP covers.

To leverage the capabilities of the Assentify Component SDK, the developer must initialize the SDK on each application start up. You will need the following values, all of which are retrieved from the Assentify DXP portal.

1. Visit the Assentify DXP and click on the Developers section, then click 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 see the information related to the flow. Retrieve the Tenant Identifier from this section.
4. To retrieve the API Key, create a new API Key or leverage an already existing key. Assign Claims to an API Key to limit the amount of access it has.
5. To fetch the Interaction Hash, click on the Flow Manager and select your flow. Once the Digital Engagement Link has loaded, copy the HASH part of https://platform.assentify.com?interaction={HASH}.

The Assentify Component SDK is available for React Native and runs against the Android and iOS native components. Retrieve your API Key, Tenant Identifier, and Interaction Hash from the Assentify DXP portal before you begin, as described under Requirements.

Because the components use the device camera and native scanning, provide the platform capture permissions and honor the device capability settings that the SDK exposes at initialization.

The assentifySdk object is an instance of AssentifySdk and is initialized with several parameters. Provide the API Key and Tenant Identifier retrieved from the DXP portal, along with the Interaction hash.

const assentifySdk = new AssentifySdk({
  apiKey: "",
  tenantIdentifier: "",
  interaction: "",
  activePerformLivenessFace: true,
  customColor: "#",
  enableDetect: true,
});

Core parameters

Capture and detection tuning

Liveness and device fallback

Initialization listener

Listen to assentifySdkInit to know when the SDK is ready.

The Assentify BlockLoader is a core component that performs several functions and gives context to the Assentify DXP platform. It provides these built-in properties that the developer sets.

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.

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 anytime, even after the application has gone live, so the application supports as many ID cards as possible without re-compiling and deploying.

This component returns many different types of information depending on the ID type being scanned, such as a Civil ID versus a Driving License, using dynamic keys and mappings built into the SDK. A global model is available so developers can 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 turn off the guides and default interface and use their own custom user interface, driven by the events fired during scanning.

startFlow

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

assentifySdk.startFlow({
  logoUrl: "",
  svgBackgroundImageUrl: "",
  textColor: "#000000",
  secondaryTextColor: "",
  backgroundCardColor: "",
  accentColor: "",
  backgroundColor: "",
  clickColor: "",
  backgroundType: "",
  language: "",
  enableNfc: false,
  enableQr: false,
  blockLoaderCustomProperties: {},
  clean: false,
});

1. Initialize the Assentify Sdk object.
2. Call AssentifySdk.startFlow().
3. Configure the startFlow parameters.
4. Listen to OnFlowCompleted.

ID Card scanning

1. Initialize the Assentify Sdk.
2. Call Assentify.startScanIDCard().
3. Configure the startScanIDCard parameters.
4. Pass the templatesByCountry parameter, which includes all the available templates that are retrieved.
5. Listen to onCompleteIDCard.

Passport scanning

1. Initialize the Assentify object.
2. Call Assentify.startScanPassport().
3. Configure the startScanPassport parameters.
4. Listen to onCompletePassport.

Other ID scanning

1. Initialize the Assentify object.
2. Call Assentify.startScanOther().
3. Configure the startScanOther parameters.
4. Listen to onCompleteOther.

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 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.

1. Initialize the Assentify object.
2. Call Assentify.startFaceMatch().
3. Configure the startFaceMatch parameters.
4. Supply the target url face image.
5. Supply the target show count down parameter, true / false.
6. Listen to onCompleteFaceMatch.

Use Context Aware Signing to collect the tokens from a selected document, create a user document instance, apply a signature, and retrieve the signed document URL.

1. Initialize the Assentify object.
2. Call Assentify.startContextAwareSigning().
3. Wait for signingOnHasTokens: the tokens from your selected document.
4. Fill the tokens and call createUserDocumentInstance.
5. Wait for signingOnCreateUserDocumentInstance: call the signature function with the base64 signature.
6. Wait for signingOnSignature: get the document URL.

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.

Listen to SubmitDataEvents to follow the submission.

Components are event driven. Each capture surfaces a BaseResponseDataModel result together with lifecycle events.

Component completion events

BaseResponseDataModel

TemplatesByCountry

KycDocumentDetails

Templates

IDExtractedModel

PassportExtractedModel

OtherExtractedModel

FaceExtractedModel

IdentificationDocumentCapture

This model contains all extracted data. Every field is of type Any?.

DocumentTokensModel

CreateUserDocumentResponseModel

SignatureResponseModel