Global Document Verification SDK
This SDK shall enable end-developers to incorporate a document capture and identity verification flow, utilising OCR capabilities to extract information from identity documents and perform verification.
As part of this SDK flow, you can integrate Bureau's Global Document Verification SDK in your application and capture the official Identity Document.
Minimum Requirements
- minSdkVersion 21
- Android X
Getting Started
Add the following lines in your root build.gradle file:
allprojects {
repositories {
...
maven {
url "https://jitpack.io"
}
}
}
The following lines can be added in the module level build.gradle file:
android {
...
compileOptions {
sourceCompatibility = 1.8
targetCompatibility = 1.8
}
}
dependencies {
....
implementation 'com.github.Bureau-Inc:gloal-doc-verification:0.0.1'
}
Initializing the SDK
The following steps can be taken to initialise the the SDK and consume the response returned from the SDK.
val verifierOptions = VerifierOptions.Builder().setRetryEnabled(false).setEnv(
ENV_SANDBOX).setCountryCode(CountryCode.IN)
.setDocType(DocType.NATIONAL_ID)
.setShowCardSelectionScreen(false)
.setShowCountrySelectionScreen(false)
.build()
val bureauClient = BureauClientProvider.getClient(findViewById<EditText>(R.id.client_id_edit).text.toString().trim(),this,verifierOptions)
bureauClient.verifyDoc(object : ScannedDataCallback{
override fun onResult(scannedData: DocVerificationResponse) {
scannedData.toString()
}})
Guidelines
- credentialID is a mandatory field and should not be passed as empty
- The referenceId from the callback should be recorded and stored in the DB on your end
- The SDK never requests permission but will give a callback if it was not handled by the primary application
- The SDK accepts an optional param known as verifierOptions that user can input custom config to which the SDK behaves accordingly
Configurations
setRetryEnabled
will allow the sdk to show a retry screen in case the doc capture fails or the captured doc is faultysetEnv
allows sdk to switch Sanbox or Production environmentsetCountryCode
allows sdk to bind to a specific country. It is mandatory to give one value if you choose to hide country selection screen. Similarly it will be overridden if user chooses a country in the country selection screensetDoctype
allows sdk to bind to a specific doc type. It is mandatory to give one value if you choose to hide card selection screen. Similarly it will be overridden if user chooses a card in the card selection screensetShowCardSelectionScreen
andsetShowCountrySelectionScreen
indicates the sdk to hide or show card or country selection screen respectively
Updated 5 months ago