LogoLogo
  • Welcome!
  • GETTING STARTED
    • Signing Up
    • Choose a Product
    • Choose an Integration Option
    • Run Your First Test Job
    • Complete Your KYC
    • Fund Your Wallet
    • Go Live!
    • Pricing
  • SUPPORTED ID TYPES & DOCUMENTS
    • For Individuals (KYC)
      • Using ID Number
        • Supported Countries
          • Côte d'Ivoire
            • National ID (without Photo)
            • Resident ID (without Photo)
          • Ghana
            • Ghana Card
            • Ghana Card (without Photo)
            • Passport
            • Voter's ID
          • Kenya
            • Alien Card
            • KRA Pin
            • National ID
            • National ID (without Photo)
            • Passport
            • Tax Information
          • Nigeria
            • Bank Account
            • BVN
            • NIN V2
            • NIN Slip Verification
            • V_NIN (Virtual NIN)
            • Phone Number
            • Voter's ID
          • South Africa
            • National ID
            • National ID (without Photo)
            • Phone Number
            • Refugee and Asylum ID
          • Uganda
            • National ID (without Photo)
            • Basic KYC in Uganda
          • Zambia
            • Bank Account
            • TPIN
          • Zimbabwe
            • National ID (without Photo)
        • Test Data
          • Customising Sandbox Test Data
        • ID Number Regex
        • Visual Samples of Supported ID Types
      • Using Document Image
        • Continents
          • Africa
          • Asia and the Middle East
          • Europe
          • North America
          • Oceania
          • South America
    • For Businesses (KYB)
      • Supported Countries
        • Nigeria
          • Business Registration
          • Tax Information
        • Kenya
          • Business Registration
        • South Africa
          • Business Registration
      • ID Number Regex
  • PRODUCTS
    • For Individuals (KYC)
      • AML Check
        • AML News Media
      • Basic KYC
      • Biometric KYC
      • Digital Address Verification
      • Document Verification
        • Document Verification
        • Enhanced Document Verification
      • Electronic Signature
      • Enhanced KYC
      • Phone Number Verification
      • SmartSelfie™ Authentication
      • SmartSelfie™ Compare
      • Smile Secure
    • For Businesses (KYB)
      • Business Verification
  • Integration Options
    • Mobile
      • Getting Started
      • Products
        • Biometric KYC
        • BVN Consent
        • Document Verification
        • Enhanced Document Verification
        • Enhanced KYC
        • SmartSelfie™ Enrollment and Authentication
        • Enhanced SmartSelfie™ Enrollment And Authentication
      • Customization
        • UI Components
      • Offline Mode
      • Release Notes
        • Android Release Notes
        • iOS Release Notes
        • Flutter Release Notes
        • React Native Release Notes
    • No-Code
      • Smile Links
        • Link FAQs
        • Rest API
    • Server to Server
      • Ruby
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
          • KYB - Business Verification
          • AML Check
        • Generate Token for Web Integration
        • Utilities
      • Python
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
          • Business Verification
        • Generate Token for Web Integration
        • Utilities
      • Java
        • Release Notes
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
        • Generate Token for Web Integration
        • Utilities
      • Node.js
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • Enhanced Document Verification
          • SmartSelfie™ Authentication
          • Business Verification
        • Generate Token for Web Integration
        • Utilities
      • PHP
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
        • Generate Token for Web Integration
        • Utilities
    • Rest API
      • Signing your API Request
        • Using Signature
      • Products
      • Postman Collection
      • Utilities
    • Web / Mobile Web
      • Web Integration
        • Installation
        • Usage
        • End User Consent
        • Support
      • Javascript SDK
        • Installation
        • Usage
        • Migration
        • Deprecated Version
          • Installation
          • Usage
          • Notes
          • Support
  • FURTHER READING
    • FAQs
      • What are your support hours?
      • How do I set up a callback?
      • How to re-enroll, deactivate or delete a user?
      • Add or remove team members
      • What are top-level keys?
      • What are partner_params?
      • How do job types map to the new product names?
      • Is there an API I can use to monitor my wallet balance?
      • Is there an API I can query to check the availability status of an ID type?
      • How do I integrate Smile ID in other countries or query other ID types?
      • What are the image types I can upload to Smile ID?
      • Why aren't Kenyan IDs returning images for some IDs queried?
      • Why are some of my bank verification requests returning 'ID authority unavailable'?
      • How can I look up a specific user's data?
      • Selfie best-practices
      • Document capture best-practices
      • What happens under the hood?
      • Guide to the user consent screen
      • What is code 2302?
      • Using the Demo App and Scanning QR codes
    • Job status
    • KYC receipts
    • Result codes
      • Error codes
    • Securing your account with two-factor authentication (2FA)
    • Security Overview
    • Troubleshooting
      • Troubleshooting error 2204 & 2205 - "You're not authorized to do that"
      • Why is my Web API job taking so long?
      • Image capture issues on web client
Powered by GitBook
On this page
  • v7.3.14
  • v7.3.5
  • v7.3.3
  • v7.2.0
  • v7.1.1
  • v7.1.0
  • v7.0.1 onwards
  • v6.4.3 onwards Migration to the new ID Capture
  • v6.4.0 to v6.4.1 onwards
  • v 6.3.x to v 6.4.x
  • DETAILS
  • SIDConfig.class
  • SIDTagManager.class

Was this helpful?

  1. Integration Options
  2. Mobile
  3. Android v7 (deprecated)
  4. Smile ID SDK

Migration Guide

A summary of moving from one version to another on the Smile Identity library

Last updated 1 year ago

Was this helpful?

v7.3.14

  • Consent has changed from a dialog to an activity see for how this now works using start activity for result instead of triggering a consent

v7.3.5

  • From 7.3.5 the SDK now requires signature instead of sec key please look for how to generate a signature

v7.3.3

  • Introduction of signature breaks sec_key implementation please look for how to generate a signature

v7.2.0

  • Removed the useIdCard method from the SIDConfig.Builder class, the SDK will now handle this internally

  • setRetryOnfailurePolicy is no longer mandatory when submitting a job� will default to 10 retries, 15 seconds apart

v7.1.1

With the introduction of android 11 google is now enforcing scoped storage as explained . If you have agent mode enabled and are capturing multiple jobs for later uploading and would like to migrate these jobs to scoped storage you need to make the following changes

  • Target android 10 in build.gradle by using targetSdkVersion 29

  • Add requestLegacyExternalStorage the AndroidManifest.xml so you can have access to external storage

<application
...
android:requestLegacyExternalStorage="true"
...
</application>
  • Request external storage read and write permissions

On job submission, all jobs stored in external storage will be migrated to scoped storage and when the right tag is provided a job will be submitted

All jobs captured going forward will be stored in scoped storage.

v7.1.0

  • Moved SmartCardView class from the com.smileidentity.libsmileid.core.idcapure package to com.smileidentity.libsmileid.core class

  • Added real time light and blur checks on ID card capture

  • Added onIDCardStateChange(IDCardState idCardState) for feedback to the realtime ID card quality checks

v7.0.1 onwards

  • SDK now handles the urls and port configuration and introduced the environment enum SIDNetData.Environment.TEST and SIDNetData.Environment.PROD to manage your Smile ID environmen

    �

v6.4.3 onwards Migration to the new ID Capture

Replace everything associated with

  • com.smileidentity.libsmileid.utils.CaptureIDCardOverlay

  • SurfaceView

  • �FrameLayout ( if copied .from the demo app)

�

�

v6.4.0 to v6.4.1 onwards

The SDK will provide validation by default and will return an error which can be either

ID_VALIDATION_INVALID_COUNTRY = 42
or
ID_VALIDATION_INVALID_ID_TYPE = 43
or
ID_VALIDATION_MISSING_REQUIRED_FIELDS = 40

You can turn off this remote validation by using

builder = new SIDConfig.Builder(this)
....
setValidateIdInfo(false)
...
builder.build();
//this will only validate to make sure there is a country, id type and id

v 6.3.x to v 6.4.x

DETAILS

This change introduced sandboxed folders for Smile Identity jobs to make sure they are app specific this uses the package name of the app implementing the Smile Identity library and as such the library requires a context on multiple occasions

SIDInfosManager.class

When getting the instance the method get instance now requires a context

//PREVIOUS
SIDInfosManager.getInstance()

CURRENT (v 6.4.x)
SIDInfosManager.getInstance(Context context)

SIDConfig.class

When getting the idle tags the method now requires a context

//PREVIOUS
public Set<String> getIdleTags()

//CURRENT (v 6.4.x)
public Set<String> getIdleTags(Context context)

SIDTagManager.class

The methods clearConfig and getConfigCache now require a context

//PREVIOUS
public void clearConfig(String tag)
public SIDConfigCache getConfigCache(String tag)

//CURRENT (v 6.4.x)
public void clearConfig(String tag,Context context)
public SIDConfigCache getConfigCache(String tag,Context context)

Added custom messaging for the ID Card capture as demonstrated

The SDK is now available on maven central and can be installed by following the

SDK now requires a Smile Config file from the partner portal available

Refer to for steps on how to implement the new ID Capture

�For more information on required fields per ID type please refer to

here
here
here
here
here
Getting Started Guide
here
New physical id capture
https://docs.smileidentity.com/general/supported-id-types