Assentify DXP SDKs Overview
The Digital Experience Platform (DXP) ships two native SDK types for onboarding and identity. The Flow SDK embeds a whole published DXP flow as a guided native journey, while the Component SDK gives you direct control of individual identity components and submits the collected data back to the Digital Experience Platform (DXP).
Install · Initialize · CaptureOverview
The Assentify SDK complements the Assentify DXP platform (SaaS). It has several capabilities and functionalities that empower developers to take complete control of the Identity extraction process. 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.
The Assentify Component SDK is available for Android native, iOS native, Flutter, and React Native. Whichever type you choose, you obtain credentials from the Developers section of the Assentify DXP portal, initialize the SDK, use its components or flow, and submit the collected data to the Digital Experience Platform (DXP).
The Two SDK Types
Assentify offers two ways to integrate identity capture into a native application. Choose the Flow SDK when you want the platform to drive the entire journey, or the Component SDK when you want to build your own experience around individual components.
| SDK type | What it does | Best for |
|---|---|---|
| Flow SDK | Embeds a whole published DXP flow as a native guided journey. The startFlow function initializes and launches the entire flow, including the UI and events configured in the Admin Portal. | Delivering a complete, platform-configured onboarding journey inside your app with minimal custom UI. |
| Component SDK | Gives direct control of individual identity components (Identification Document Capture, Face Capture/Matching, Context-Aware Signing, and more) and submits collected data to the Digital Experience Platform (DXP). | Building a custom experience where you control each component and aggregate or manipulate data before submission. |
Flow SDK
The Flow SDK embeds a whole published DXP flow as a native guided journey. You call startFlow, which initializes and launches the entire flow, including the UI and events configured in the Admin Portal. The flow is the one you publish and configure on the platform, so the journey, its steps, and its look-and-feel are managed centrally.
The startFlow method accepts flow environmental conditions that let you theme the embedded journey. Only backgroundType is required; the remaining parameters are optional.
| Parameter | Required | Description |
|---|---|---|
backgroundType | Yes | Defines how the background should be rendered (for example: color or image). This is the only required field. |
logoUrl | Optional | URL of the logo displayed in the flow header or main screen. |
svgBackgroundImageUrl | Optional | URL of the SVG background image used for the screen background. |
textColor | Optional | Primary text color in HEX format (for example: #000000). |
secondaryTextColor | Optional | Secondary text color in HEX format, used for subtitles or less prominent text. |
backgroundCardColor | Optional | Background color for cards and containers in HEX format. |
accentColor | Optional | Accent color used for highlights and interactive elements. |
backgroundColor | Optional | Defines the main background style of the screen. Can be Solid (single color) or Gradient (multiple colors with angle). |
clickColor | Optional | Defines the background style applied on click or pressed states. |
Language | Optional | You can optionally set the language that the OCR will process the extracted content from the cards. |
enableNfc, enableQr | Optional | Triggers NFC scanning after scanning a passport, or QR scanning after scanning a card. |
blockLoaderCustomProperties | Optional | Map containing the custom properties configured in the Admin Portal. |
- Initialize the Assentify SDK object.
- Call
AssentifySdk.startFlow(). - Configure the
startFlowparameters. - Handle flow completion through the flow callback (for example, listen to
OnFlowCompleted).
https://platform.assentify.com?interaction={HASH}. To generate that URL and pass custom properties through it, see the Flow URL and Engagement API page.Component SDK
The Assentify Component SDK gives the developer complete control of the Identity extraction process through individual, standalone, event-driven components. Each component can use its built-in default user interface, or the developer can turn off the guides and default interface and supply their own design. This lets the integrating application create any design it wants without affecting the performance or capabilities of the scanning and extraction process, while retaining complete control of what is displayed on screen through the events fired during scanning.
The Component SDK is available for iOS native, Android native, Flutter, and React Native. The StepID represents the ID of the step in the Engagement block that you configure in the Flow Builder on the portal (for example, the StepID of Face Capture or ID Capture); you need it to submit your data to the portal.
Credentials
To initialize the Component SDK you require the following variables, all 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.
| Variable | Where to obtain it |
|---|---|
API Key | Create a new API Key, or use an existing one, in the Developers section. You can assign Claims to an API Key to limit the amount of access a specific key has. |
Tenant Identifier | Visit the Developers section, click Flow Configuration, select your flow, and choose the Engagement block. The Tenant Identifier is shown in the block information. |
Interaction Hash | Open the Flow Manager and select your flow. When the Digital Engagement Link loads, its format is https://platform.assentify.com?interaction={HASH}; copy the HASH part to retrieve the interaction hash. |
The assentifySdk object is an instance of AssentifySdk and is initialized with these parameters, including apiKey, tenantIdentifier, and interaction. An initialization callback (onAssentifySdkInitSuccess) signals success, and onAssentifySdkInitError is executed upon failure to initialize the SDK.
assentifySdk = AssentifySdk(
apiKey: "",
tenantIdentifier: "",
interaction: ""
)Initialize, Use, Submit
Every Component SDK integration follows the same shape: get an API Key and Tenant Identifier from the Developers section, initialize the SDK on each application start up, use the components you need, and submit the collected data to the Digital Experience Platform (DXP).
- Retrieve your API Key, Tenant Identifier, and Interaction Hash from the Developers section of the Assentify DXP portal.
- Initialize the SDK on application start up. On success, call
getTemplates, which returns aList<TemplatesByCountry>; store the result for use when processing an ID Card. - Use the components you need, such as
startScanIDCard,startScanPassport,startScanOther, orstartFaceMatch. - Set the Wrap Up step (which supplies the flow end time) and populate the BlockLoader, including any custom properties.
- Prepare your list of steps with the
outputPropertiesobtained for each step, set eachSubmitRequestModelinto a list, and callstartSubmitData()to submit to the Digital Experience Platform (DXP).
OnBoardMe_Property_{propertyName} naming nomenclature for all custom properties declared in your app.Supported Components
The Component SDK exposes the following standalone components. Availability of a given component varies by platform source; consult each platform's SDK page for the exact methods it documents.
| Component | Purpose |
|---|---|
| Identification Document Capture | A standalone, event-driven component that extracts information from an ID Card. The ID type is determined by the configuration set in Assentify DXP and can be managed even after the application has gone live. Methods include getTemplates, startScanIDCard, startScanPassport, and startScanOther. |
| Face Capture/Matching | A standalone, event-driven component that performs face matching between a live source and a target image. The developer supplies the target image and the selfie camera captures the source. Started with startFaceMatch. |
| NFC Passport Scanning | Reads an NFC-enabled passport. Documented as readPassport (iOS), startScanNfc (Android), and startNfc (Flutter) in the respective sources. |
| Context-Aware Signing | Programmatically creates files pre-filled with tokens retrieved from the Assentify DXP, then adds a user signature. Started with startContextAwareSigning. |
| BlockLoader | A core component that provides context properties to the DXP and lets you add custom properties for submission. |
| Wrap Up | A built-in step that allows the developer to set the TimeEnded value, supplying an end time for the flow. |
| Submission | A built-in function that initiates data transmission from the integrating app to Assentify DXP, allowing data aggregation and manipulation before sending. Called via startSubmitData. |
onComplete fires, the application receives all the information and is responsible for transferring it. To trigger your backend after submission, define a webhook in the connector block.Platform SDK Pages
The Component SDK is available for the four native platforms below. Each platform's page documents its exact initialization callbacks, method names, and data models.
| Platform | Component SDK page |
|---|---|
| iOS (native) | iOS Component SDK |
| Android (native) | Android Component SDK |
| Flutter | Flutter Component SDK |
| React Native | React Native Component SDK |