Register/Enroll

Running SmartSelfie™ Authentication on Android

1. Create a Callback Endpoint

2. Get your user's Selfie

3. Register the user

4. Submit the Job to Smile ID

5. Interpret your results

Registering a User

The SmartSelfie™ Authentication entails comparing a SmartSelfie™ against the Selfie on file of a registered user. To register a user, the job request payload is exactly the same as a SmartSelfie™ Authentication except for two differences (both changes are to be made in the Making a Job Request section of this page):

1. Since you are just registering the user, you need a new user_id (details of Key in Making a Job Request section of this page)

2. Set the job_type to "4" (details of Key in Making a Job Request section of this page)

If you are performing a SmartSelfie™ Authentication for a user you've previous Registered or performed ran a successful Biometric KYC or Document Verification on, you can skip the "Registering a User" section in the rest of this page.

Get the User's Selfie

To successfully run SmartSelfie™ Authentication jobs you need to submit the user's selfie.When using the Smile ID UI please see Presenting Screens and Selfie Configuration on how to present the selfie capture screen and when using the Smile ID SDK please see Smartselfie Capture on how to integrate directly with the selfie capture view.

Submit the Job to Smile ID

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

SIDMetadata is useful for information that needs to be sent to Smile ID, it provides a way of setting PartnerParams which are useful for sending job related information and SIDUserInfo which is useful for sending user id related information. Once instantiated please reuse the same instance per job but it's important to make sure this is not reused across jobs

Step 1.Set the Partner Params related to the job

PartnerParams partnerParams = metadata.getPartnerParams();
partnerParams.setJobId(<Job ID>);// unique identifier string per job
partnerParams.setUserId();// unique identifier for the user information being processed
partnerParams.additionalValue(<key>,<value>)//string key and value
                                            // for anything etra which you may need associated with the job

Step 2:Create the config

//Set the environment which can be either
// SIDNetData.Environment.PROD or  SIDNetData.Environment.TEST
//

SIDNetData data = new SIDNetData(this, SIDNetData.Environment.PROD);

SIDConfig config = new SIDConfig.Builder(this)
.setSmileIdNetData(data) //Environment information
.setGeoInformation(<GeoInfos>)//optional GeoInfos with geo information
.setSIDMetadata(metadata)//the same object with partner params and user id info
.setJobType(4);//int must be set to 4
.setAllowNewEnroll(<true/false>) ==> will allow reuse of user ids
.useEnrolledImage(<true/false>) ==> will allow to update enrolled selfie
.setMode(SIDConfig.Mode.ENROLL)//
.build(<TAG>)// string must be a unique string

Step 4: Submit the Job

SIDNetworkRequest sIDNetworkRequest = new SIDNetworkRequest(<Contect>)
mSINetworkRequest.setOnCompleteListener(this);
mSINetworkRequest.setOnEnrolledListener(this);
mSINetworkRequest.set0nErrorListener(this);
mSINetworkRequest.submit(config)//the object from above

Step 5: Interpret your results

SIDResponse object will contain results returned from the api this contains strongly typed method to get the response as individual items or as json object or as a string, for more information on how to interpret results you can read more about result codes and responses in the SmartSelfie™ Authentication section of the docs.