Lookup Flow

Note: This feature requires an additional permission and must be explicitly requested

The "Lookp Flow" it's the same as the "Enrollment Flow" with the only difference that the first step is not the automatic scanning of a document through the camera phone but the user is asked to manually type in some information of the document that can be used to perform the lookup on the government database. Only one document at the time is supported. Other features like facial recognition and background check can be enabled in the same way as per the "Enrollment Flow". Note that not all the documents are supported.

In order to use our SDK you need an authorization token. Please check our API "Authorisation" in this regard.

The following method should be called when the application is initiated:

UqudoSDK.init(applicationContext)

The Uqudo SDK provides a builder class to initiate the "Lookup Flow". See the example below:

try {
   val uqudoIntent = UqudoBuilder.Lookup()
            .setToken(authorizationToken)
            .setDocumentType(DocumentType.NGA_DL)
            .enableFacialRecognition(
                     FacialRecognitionConfigurationBuilder()
                              .setLookupMinimumMatchLevel(4)
                              .build()
            )
            .enableBackgroundCheck(
                     BackgroundCheckConfigurationBuilder()
                              .skipView()
                              .build()
            )
            .build(this)
        startActivityForResult(uqudoIntent, 101)
} catch( e: Exception ){
    ...
}

Uqudo Lookup Builder Configuration

In order to check if the document type supports the "Lookup Flow" you can use the following method:

DocumentType.NGA_DL.lookupSupported

Configuration options provided in the Uqudo Lookup builder are:

PropertyTypeOptionalDefaultDescription

setToken(token)

String

No

null

setNonce(nonce)

String

(max size 64 chars)

Yes

null

Nonce provided by the customer mobile application when the SDK is initiated. It is useful to make sure the process has been initiated by the customer mobile application. It should be generated server side.

setSessionId(sessionId)

String

(UUID v4)

Yes

Auto generated

Note: make sure to create always a new session id when you trigger the SDK flow

disableSecureWindow()

None

Yes

false

Whether to allow users to take screenshots and capture screen recording or not.

enableFacialRecognition()

None

Yes

None

Enable facial recognition with a default configuration, see Facial Recognition Configuration.

enableFacialRecognition(configuration)

FacialRecognitionSpecification

Yes

None

Enable facial recognition with a custom configuration, see Facial Recognition Configuration.

enableBackgroundCheck(configuration)

BackgroundCheckSpecification

Yes

None

Enable background check with a custom configuration, see Background Check Configuration.

setDocumentType(document)

Document

No

None

Set the document type. Please refer to the Scan API for supported Document Types.

returnDataForIncompleteSession()

None

Yes

false

When enabled, if the user or the SDK drops the session before completion, the SDK will return the partial data together with the SessionStatus object (see Handling the Result). Please note that you can expect some data only if the user passes at least the lookup step

Facial Recognition Configuration

In order to check if the document type supports facial recognition you can use the following method:

DocumentType.NGA_DL.lookupFacialRecognitionSupported

By default the facial recognition is disabled. You need to enable Facial Recognition explicitly. See the example below:

...
        .enableFacialRecognition(
           FacialRecognitionConfigurationBuilder()
              .setLookupMinimumMatchLevel(4)
              .build()
        )

Facial Recognition configuration options available:

PropertyTypeOptionalDefaultDescription

setLookupMinimumMatchLevel(matchLevel)

Int

Yes

None

Defines the minimum match level that the facial recognition has to meet for pictures from the government database

setMaxAttempts(maxAttempts)

Int

Yes

3

Set the max failed facial recognition attempts before dropping the session. Note: only values between 1 and 3 are taken into consideration.

allowClosedEyes()

None

Yes

False

Allows to have closed eyes during facial recognition.

enableOneToNVerification()

None

Yes

False

Once activated, following a successful facial recognition (confirming liveness and matching the face), the system initiates a search for the user's selfie within your tenant. If the selfie is not found, it is added, and the indexed facial features are stored in the database. The SDK result includes a unique ID in the face object, along with an indication of whether there was a match with a previously onboarded selfie. It's essential to store this unique ID in your system alongside the user's record, facilitating future searches for users with the same ID. Please be aware that this option requires a specific permission, otherwise, it will be disregarded

Background Check Configuration

Note: This feature requires an additional permission and must be explicitly requested

By default the Background Check is disabled. You need to enable Background Check explicitly. See the example below:

...
        .enableBackgroundCheck(
             BackgroundCheckConfigurationBuilder()
               .skipView()
               .build()
         )

Background Check configuration options available:

PropertyTypeOptionalDefaultDescription

disableConsent()

None

Yes

false

Disable consent option for the user

setBackgroundCheckType(type)

BackgroundCheckType

Yes

RDC

Sets the background check type

enableMonitoring()

None

Yes

false

Enable continuous monitoring

skipView()

None

Yes

false

If enabled, the step will be skipped, and the SDK will trigger the background check without any user interaction.

Handling Exceptions

The Uqudo SDK will throw certain exceptions which need to be handled by the application. The Exceptions are:

  1. IllegalStateException - e.g. enabling the "Lookup Flow" for a document that doesnโ€™t support it or because facial recognition is enabled and the documcent doesn't support it or because of some required configuration missing

  2. UnsupportedDeviceException - e.g. the device is rooted

Handling the Result

The enrollment result will be available to the application in the calling Activityโ€™s onActivityResult method:

...
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
   super.onActivityResult(requestCode, resultCode, data)
   if (resultCode == Activity.RESULT_OK) {
       val result = data?.getStringExtra("data")
   } else if (resultCode == Activity.RESULT_CANCELED) {
       if (data != null) {
         val sessionStatus = data.getParcelableExtra("key_session_status") as SessionStatus
         println("Enrollment failed due to ${sessionStatus.sessionStatusCode.message} at ${sessionStatus.sessionTask.name()}")
       }
   }
}

If the resultCode is equals to Activity.RESULT_OK you can find the SDK result in the data attribute. The string is the JWS, see "SDK result" for details.

If the resultCode is equals to Activity.RESULT_CANCELED you can find the SessionStatus object result in the data attribute under the key โ€œkey_session_statusโ€. The SessionStatus contains the following properties:

sessionStatusCode as SessionStatusCode enum that contains the following error codes:

  1. USER_CANCELLED = User canceled the enrollment process

  2. SESSION_EXPIRED = Session expired or not found

  3. UNEXPECTED_ERROR = Something went wrong

  4. SESSION_INVALIDATED_OTP_TOO_MANY_ATTEMPTS = Some documents require an OTP step. The error is trigger if for example the OTP expires multiple times and the user is not moving forward

  5. SESSION_INVALIDATED_FACE_RECOGNITION_TOO_MANY_ATTEMPTS = Session gets invalidated because of too many failed facial recognition attempts

sessionTask as SessionTask enum that contains the following codes:

  1. LOOKUP = The lookup task

  2. FACE = The facial recognition task

  3. BACKGROUND_CHECK = The background check task (only if skipView() is not enabled)

data as String that contains the JWS object with the partial data of an incomplete KYC session. Returning the partial data for an incomplete KYC session is disabled by default, please see the related option in the Lookup Configuration Builder for details.

Last updated