CheckinResultsClient class
Optional Checkin.com Results API client.
Fetches verification outcomes (OCR fields, overall status, and pre-signed
document/selfie/image URIs) via:
GET {apiUrl}/api/v1/application/{applicationIdOrExternalId}
with header X-API-Key: {apiKey}.
This is separate from the native GetID scan flow (FlutterCheckinSdk). Apps that only run the plugin scan do not need this class.
Throws InvalidConfiguration if apiKey or apiUrl is empty when the
client is created or when getVerification is called.
Constructors
- CheckinResultsClient({required String apiUrl, required String apiKey, Client? httpClient})
Properties
- apiUrl → String
-
Dashboard Results API base URL (e.g.
https://your-company.getid.ee).no setter - hasApiKey → bool
-
Whether a non-empty external API key was provided.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
dispose(
) → void - Closes the underlying HTTP client when this instance created it.
-
getVerification(
String applicationIdOrExternalId) → Future< CheckinVerificationResult> -
Loads a verification by Checkin
applicationIdorexternalId. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited