SmileIDService class

Constructors

SmileIDService(SmileIDApi platformInterface)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

platformInterface ↔ SmileIDApi

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

authenticate(FlutterAuthenticationRequest request) → Future<FlutterAuthenticationResponse?>

Returns a signature and timestamp that can be used to authenticate future requests

doEnhancedKyc(FlutterEnhancedKycRequest request) → Future<FlutterEnhancedKycResponse>

Queries the Identity Information of an individual using their ID number from a supported ID Type. Returns the personal information of the individual found in the database of the ID authority.

doEnhancedKycAsync(FlutterEnhancedKycRequest request) → Future<FlutterEnhancedKycAsyncResponse>

Same as doEnhancedKyc, but the final result is delivered to the URL provided in the (required) FlutterEnhancedKycRequest.callbackUrl field.

doSmartSelfieAuthentication(String signature, String timestamp, String selfieImage, List<String> livenessImages, String userId, Map<String?, String?>? partnerParams, String? callbackUrl, int? sandboxResult) → Future<FlutterSmartSelfieResponse>

Perform a synchronous SmartSelfie Authentication. The response will include the final result of the authentication.

doSmartSelfieEnrollment(String signature, String timestamp, String selfieImage, List<String> livenessImages, String userId, Map<String?, String?>? partnerParams, String? callbackUrl, int? sandboxResult, bool? allowNewEnroll) → Future<FlutterSmartSelfieResponse>

Perform a synchronous SmartSelfie Enrollment. The response will include the final result of the enrollment.

getBiometricKycJobStatus(FlutterJobStatusRequest request) → Future<FlutterBiometricKycJobStatusResponse>

Fetches the status of a Job. This can be used to check if a Job is complete, and if so, whether it was successful. This should be called when the Job is known to be a Biometric KYC.

getDocumentVerificationJobStatus(FlutterJobStatusRequest request) → Future<FlutterDocumentVerificationJobStatusResponse>

Fetches the status of a Job. This can be used to check if a Job is complete, and if so, whether it was successful. This should be called when the Job is known to be a Document Verification.

getEnhancedDocumentVerificationJobStatus(FlutterJobStatusRequest request) → Future<FlutterEnhancedDocumentVerificationJobStatusResponse>

Fetches the status of a Job. This can be used to check if a Job is complete, and if so, whether it was successful. This should be called when the Job is known to be Enhanced DocV.

getProductsConfig(FlutterProductsConfigRequest request) → Future<FlutterProductsConfigResponse>

Returns the ID types that are enabled for authenticated partner and which of those require consent

getServices() → Future<FlutterServicesResponse>

Returns supported products and metadata

getSmartSelfieJobStatus(FlutterJobStatusRequest request) → Future<FlutterSmartSelfieJobStatusResponse>

Fetches the status of a Job. This can be used to check if a Job is complete, and if so, whether it was successful. This should be called when the Job is known to be a SmartSelfie Authentication/Registration.

getValidDocuments(FlutterProductsConfigRequest request) → Future<FlutterValidDocumentsResponse>

Returns Global DocV supported products and metadata

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pollBiometricKycJobStatus(FlutterJobStatusRequest request, int interval, int numAttempts) → Future<FlutterBiometricKycJobStatusResponse>

Polls the status of a biometric kyc job

pollDocumentVerificationJobStatus(FlutterJobStatusRequest request, int interval, int numAttempts) → Future<FlutterDocumentVerificationJobStatusResponse>

Polls the status of a document verification job

pollEnhancedDocumentVerificationJobStatus(FlutterJobStatusRequest request, int interval, int numAttempts) → Future<FlutterEnhancedDocumentVerificationJobStatusResponse>

Polls the status of a an enhanced document verification job

pollSmartSelfieJobStatus(FlutterJobStatusRequest request, int interval, int numAttempts) → Future<FlutterSmartSelfieJobStatusResponse>

Polls the status of a Smart Selfie job.

prepareUpload(FlutterPrepUploadRequest request) → Future<FlutterPrepUploadResponse>

Used by Job Types that need to upload a file to the server. The response contains the URL (FlutterPrepUploadResponse.uploadUrl) that the file should eventually be uploaded to (via upload)

toString() → String

A string representation of this object.

inherited

upload(String url, FlutterUploadRequest request) → Future<void>

Uploads files to S3. The URL should be the one returned by prepareUpload. The files will be uploaded in the order they are provided in FlutterUploadRequest.images, and will be zipped together by the corresponding Dart/Flutter mechanism.

Operators

operator ==(Object other) → bool

The equality operator.

inherited