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
  • SIDConfig SUMMARY
  • �Submit The Job

Was this helpful?

  1. Integration Options
  2. Mobile
  3. Android v7 (deprecated)

SIDConfig

This is the core part of a Smile ID job configuration which has information on how information should be sent and has 7 main methods

This is the core part of a Smile ID job configuration which has information on how information should be sent and has 7 main methods

This is the core part of a Smile ID job configuration which has information on how information should be sent and has 7 main methods

1.setRetryOnfailurePolicy

Takes a parameter of class RetryOnFailurePolicy which is described below

//instantiate the class
RetryOnFailurePolicy retryOnFailurePolicy = new RetryOnFailurePolicy();

//set the number of times a retry should be attempted before giving up
retryOnFailurePolicy.setRetryCount(10);

//set the spacing in milliseconds between consecutive retries
retryOnFailurePolicy.setRetryTimeout(TimeUnit.SECONDS.toMillis(15));

2.setMode setSmileIdNetData

Takes a parameter of the enum SIDConfig.Mode described below\

//auth type jobs eg job type 2 and job type 8
SIDConfig.Mode.AUTHENTICATION

//enroll/register type jobs eg 1 and 4
SIDConfig.Mode.ENROLL

3. setSmileIdNetData

�

Takes a parameter of the class SIDNetData described below

//for the test environment
SIDNetData data = new SIDNetData(<Context>, SIDNetData.Environment.TEST);

//for the prod environment
SIDNetData data = new SIDNetData(<Context>, SIDNetData.Environment.PROD);

4. � setGeoInformation

Takes a parameter of class GeoInfos described below

//instantiate the class
GeoInfos infos = new GeoInfos();

//sets the accuracy of the location in meters
infos.setAccuracy(accuracy);

//sets the altitude
infos.setAltitude(altitude);

//sets the latitude
infos.setLatitude(latitude);

//sets the longitude
infos.setLongitude(longitude);

//sets the last updated elapsed time
infos.setLastUpdate(lastUpdate);

//confirms the permissions have been granted or not
infos.setGeoPermissionGranted(mGeoPermissionGranted);

5. � setSIDMetadata

�Takes a parameter of class SIDMetadata which is is an object used to send two different kinds of metadata the first one being the User id information and partner parameters which can be associated with jobs to instantiate the metadata object you do the below

//Instantiation
SIDMetadata metadata = new SIDMetadata();

//To get the user id information
 SIDUserIdInfo userIdInfo = metadata.getSidUserIdInfo();

//To get the partner parameters
PartnerParams params  = metadata.getPartnerParams();

5. � setJobType

6. useIdCard

Takes a boolean parameter confirming if this job has an id card image associated with it

7. (Optional) Set a callback url

From version 6.4.2 there is added functionality to set custom callback using the SDK, this can be done by using the SIDNetData class. After setting the other settings in this class then call the methodsetCallBackUrl as in the example below

If the call back URL is not set from the SDK it will always default to the setting on the backend.

SIDNetData data = new SIDNetData();
....//other SIDNetData settings
data.setCallBackUrl(https://example.com/callback);

SIDConfig SUMMARY

SIDConfig sidConfig = new SIDConfig.Builder(this)
        .setRetryOnfailurePolicy(getRetryOnFailurePolicy())
        .setMode(SIDConfig.Mode.ENROLL)
        .setSmileIdNetData(data)
        .setGeoInformation(infos)
        .setSIDMetadata(metadata)
        .setAllowNewEnroll(<true/false>) ==> will allow reuse of user ids
        .useEnrolledImage(<true/false>) ==> will allow to update enrolled selfie
        .setJobType(jobType)
        .useIdCard(useIdCard)
        .build();

�Submit The Job

//Instantiate SIDNetworkRequest object to send
SIDNetworkRequest mSINetworkrequest = new SIDNetworkRequest(this);
...
...
...
//submit the job
mSINetworkrequest.submit(sidConfig);

Last updated 12 months ago

Was this helpful?

For more information on this checkout

Takes an integer parameter and sets the job type for more information on this checkout

More information on callback URL can be found

this guide
this guide on job types
here