IDcheckIO Mobile SDK
The IDcheckIO Mobile SDK embeds IDnow's identity verification flow directly into your application. It captures identity documents, reads NFC chips, performs biometric liveness checks, and uploads everything to the Customer Identification Service (CIS) for analysis.
This guide covers version 8.x on all four supported platforms. Use the version dropdown in the top navigation bar to switch to 9.x or 7.x.
Pick a session mode
The SDK offers two ways to run a verification. Choose one before you start integrating.
| Onboarding mode | Online mode | |
|---|---|---|
| Recommended | Yes | No, existing integrations only |
| Configuration | Server side, by your CSM team | In your application code |
| Multi document flows | Chained automatically by the SDK | You chain each capture yourself |
| Code required | One startOnboarding call | One session per document, plus context passing |
Use Onboarding mode unless you have a requirement it cannot meet. It moves all flow configuration to the server, so changing the document list or the capture behavior does not require an app release.
Online mode is kept for integrations that already use it and for cases where you need per session control from the client. Discuss your requirements with your CSM team before choosing it.
Integration path
- Check requirements for your platform and minimum OS version.
- Install the SDK and grant the camera and NFC permissions.
- Initialize the SDK by preloading it and activating your license token.
- Start a session, either an onboarding or an online session.
- Handle errors returned by the session.
Planning to move to 9.x later? The 8.x to 9.x migration guide lists what the upgrade will require of you. The Online mode API changes substantially in 9.x, so it is worth reading before you commit to a large Online mode integration.
Getting help
Your Customer Success Management (CSM) team provides your activation token, your repository credentials, and all server side flow configuration. Contact them for anything that cannot be set from the client.
Sample projets
To facilitate SDK integration, we provide sample projects for Android and iOS. These demonstrate a complete integration of our product and can serve as a reference for configuring the SDK, launching a user journey, and handling key results and errors.
The sample projects are not intended for direct use in production. They provide a reference implementation that you can adapt to your application's needs, architecture, and security policies.