Consent Screen
The SDK has prebuilt screens to request consent from a user before running a job which may return personal identifiable information. This gives the user control and also ensures compliance
Last updated
The SDK has prebuilt screens to request consent from a user before running a job which may return personal identifiable information. This gives the user control and also ensures compliance
Last updated
On android the screen is instantiated as a dialog on top of your app and on iOS the screen is instantiated as a view controller so it is important to take this into consideration if you have any navigation that is expected before or after the consent screen has been shown
TAG <STRING>This is important that it matches the same tag which may have been or will be used to capture the selfie and or id card document as it will determine if the job will be submitted or not when consent is required for the id type
COMPANY_LOGO <STRING> This is a string typically the app icon name it has to be the name of an image resource in your res folder for android and or in your assets for iOS, so the user is familiar with what they will finally see which the SDK will present on the consent screen. Ideal sizes for this resource are 48x48 mdpi 72x72 hdpi
96x96 xhdpi
144x144 xxhdpi
192x192 xxxhdpi
BUNDLE_ID/PACKAGE_NAME <STRING> This is your app's bundle id on iOS and your app's package name on android, this will be used to fetch the resources to be shown on the consent screen
COMPANY_NAME <STRING>This is the company name that will be presented on the consent screen
PRIVACY_URL <STRING> This is a link to a valid web page that contains your company's privacy policy the user can click this and view the privacy policy.
The consent screen will be shown and this code runs asynchronously and will show the below screens for iOS and android and will return a hashmap which containts a key SID_RESULT_CODE
anything other than -1 means it the user has declined consent and -1 means the user agreed to consent and you may proceed as normal
The SDK has prebuilt screens to request consent from a user before running a job with the BVN ID Type.
The screen is instantiated as a activity so it is important to take this into consideration if you have any navigation that is expected and whether to show it from a fragment or from an activity.
Add a theme in your app's styles which looks like the below
Declare the smile id consent activities in your app's android manifest
Show the consent when ready
If ENVIRONMENT
is set to false
(for sandbox), enter the following on the screen for BVN and OTP:
BVN: 00000000000
OTP: 000000
Any other BVN or OTP will return invalid errors
If the consent flow succeeds then it returns a promise with an object with key value maps and which will contain
<SID_RESULT_CODE>
This will be 1 for success and 0 for failed
SUCCESS STATE
<TAG>
the tag used to identify the end to end process for this job which should be an alphanumeric string
<BVNNUMBER>
the user entered BVN number
<SESSION_ID>
the session_id which should be sent together with the userIdInfo with a key session_id and this value
FAILED STATE
<ERROR_VALUE>
The reason for the failure
<TAG>
The tag used to request consent\
If for any reason the consent flow fails the catch block will return an exception with an error code and an error message
Possible ERROR_VALUE are
777 Missing partner name
778 Missing partner Logo
779 Error with your configuration please check documentation
780 User declined consent summary
781 A network error occurred
782 An error occurred with auth smile
783 An error occurred after inputing the BVN number this may be the user entered an invalid BVN error or there was a connection issue whilst initiating consent
784 An error occurred after selecting the mode (sms/email) or the user clicked this is likely a network or server error
785 An error occurred because the presented mode of confirmation are no longer valid for the user so they clicked these are invalid
786 An error occurred during OTP validation
This will present the below screens
Variable | Description |
---|---|
TAG
This is a local unique job identifier which you can use to identify the end to end process for this job which should be an alphanumeric string
ID_TYPE
Can be BVN or BVN_MFA the user will be shown BVN as the id type they are consenting to
COMPANY_NAME
The company name to be shown to the user
COMPANY_LOGO
The company logo to be shown to the user
<BUNDLE_ID/PACKAGE_NAME>
You apps package name for android or bundle id for iOS
ENVIRONMENT
true
for production and false
for sandbox
PRIVACY_POLICY
A valid url to your company's privacy policy