checkin_results library

Optional Checkin.com Results API (external X-API-Key).

Import this library only when you need verification outcomes and media URIs after a scan. The native GetID plugin (package:flutter_checkin_sdk/flutter_checkin_sdk.dart) works without it.

import 'package:flutter_checkin_sdk/checkin_results.dart';

final client = CheckinResultsClient(
  apiUrl: 'https://your-company.getid.ee',
  apiKey: 'YOUR_RESULTS_API_KEY',
);
final result = await client.getVerification(applicationId);
print(result.documentFrontUri);

Classes

CheckinExtractedField

OCR / data-extraction field from servicesResults.docCheck.extracted.ocr.

CheckinMediaFile

Media file returned by the Checkin.com Results API (documents, selfies, OCR images).

CheckinOverallResult

Overall verification decision from the Results API overallResult object.

CheckinResultComment

Per-service comment inside CheckinOverallResult.comments.

CheckinResultsClient

Optional Checkin.com Results API client.

CheckinVerificationResult

Parsed Checkin.com Results API application payload.

Functions

mapNativeErrorToException({required String code, required String message, String? nativeError}) → CheckinException

Converts a native GetIDError code into a strongly typed CheckinException.

mapPlatformException({required String code, required String message, String? details}) → CheckinException

Converts a PlatformException-like map from the method channel into a CheckinException.

Exceptions / Errors

CameraPermissionDenied

Thrown when a required permission (e.g. camera) is denied.

CheckinException

Base class for all Checkin.com plugin exceptions.

InitializationException

Thrown when plugin initialization fails.

InvalidConfiguration

Thrown when configuration values such as API URL, flow name, or SDK key are invalid.

NetworkException

Thrown when the SDK cannot communicate with the Checkin.com backend.

SessionExpired

Thrown when the JWT or liveness token has expired.

UnknownCheckinException

Thrown for unrecognized or unexpected native errors.

UnsupportedCheckinException

Thrown when the native SDK does not support a requested operation.

VerificationException

Thrown when a verification flow fails to start or complete.