Document Verification
Perform a Document Verification Job
Document Verification is exposed as a flow which performs the following high level steps:
Displays instructions to the user
Requests camera permissions (if not already granted)
Performs Document Capture
Performs Selfie Capture
Submits the job to the Smile ID API
Delivers the result back to the caller
Arguments
The Javadocs also contain detailed information regarding each parameter.
country
country
A 2-letter country code (ISO 3166-1 alpha-2 compliant)
documentType
documentType
The type of document/ID that is to be captured. If omitted, the document type will be automatically determined
captureBothSides
captureBothSides
Boolean indicating whether both sides of the ID card should be captured. When set to true, the user will still be presented with the option to skip capturing the back of the ID card. This value can be fetched by calling SmileID.api.getValidDocuments()
and checking the hasBack
property of a document
bypassSelfieCaptureWithFile
bypassSelfieCaptureWithFile
If this value is provided, then the user will not be asked to capture a selfie as part of this flow
userId
userId
The user ID to associate with the job. Most often, this will correspond to a unique User ID within your own system. (If not provided at time of Registration, a random user ID will be generated. This field is required for Authentication)
jobId
jobId
The job ID to associate with the job. Most often, this will correspond to a unique Job ID within your own system. If not provided, a random job ID will be generated.
idAspectRatio
idAspectRatio
The aspect ratio of the ID to be captured. If not specified, the aspect ratio will attempt to be inferred from the device's camera.
showAttribution
showAttribution
Whether to show the Smile ID attribution or not on the Instructions screen
allowGalleryUpload
allowGalleryUpload
Whether the user should be allowed to upload their document photos from the Gallery instead of performing a live capture
showInstructions
showInstructions
Whether to deactivate capture screen's instructions
extraPartnerParams
extraPartnerParams
Custom values specific to partners passed as an immutable map
colorScheme
colorScheme
typography
typography
onResult
onResult
Callback to be invoked when the job is complete. The result itself is a SmileIDResult
which can either be a SmileIDResult.Success
or SmileIDResult.Error
Last updated