ekyc_flutter_sdk 1.0.1

A comprehensive Flutter SDK for eKYC (electronic Know Your Customer) identity verification. Supports NFC scanning of Japanese driver's licenses, My Number cards, and residence cards with face liveness [...]

eKYC Flutter SDK

A comprehensive Flutter SDK for eKYC (electronic Know Your Customer) identity verification in Japan.

日本語 | English

---

English

Features

• Driver's License verification (NFC reading)
• My Number Card verification (NFC reading)
• Residence Card verification (NFC reading)
• Face liveness detection
• Face matching verification

Installation

Add this to your pubspec.yaml:

dependencies:
  ekyc_flutter_sdk: ^1.0.0

Then run:

flutter pub get

Quick Start

import 'package:ekyc_flutter_sdk/ekyc_flutter_sdk.dart';

// Initialize the SDK
final kycClient = KycApiClient(apiKey: 'YOUR_API_KEY');

// Create KYC request
final kycRequest = await kycClient.createKycRequest(token: authToken);
final requestId = kycRequest['id'].toString();

// Scan driver's license
final result = await kycClient.scanDriverLicense(
  pin1: '1234',
  pin2: '5678',
  token: authToken,
  tKycRequestId: requestId,
);

Setup

iOS

Add the following to your Info.plist:

<key>NFCReaderUsageDescription</key>
<string>This app uses NFC to read identity documents for verification.</string>
<key>NSCameraUsageDescription</key>
<string>This app uses the camera to capture identity documents.</string>
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
    <string>D2760000850100</string>
    <string>D2760000850101</string>
    <string>D2760001180101</string>
</array>

Android

Add the following to your AndroidManifest.xml:

<!-- NFC permissions -->
<uses-permission android:name="android.permission.NFC" />
<uses-feature android:name="android.hardware.nfc" android:required="true" />

<!-- Camera permissions -->
<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="true" />

<!-- NFC intent filter in your activity -->
<activity>
    <intent-filter>
        <action android:name="android.nfc.action.TECH_DISCOVERED"/>
        <category android:name="android.intent.category.DEFAULT"/>
    </intent-filter>
    <meta-data
        android:name="android.nfc.action.TECH_DISCOVERED"
        android:resource="@xml/nfc_tech_filter" />
</activity>

Example

See the example directory for a complete working example.

Requirements

• iOS 13.0+ or Android 6.0+ (API 23+)
• Device with NFC capability
• Valid API key and authentication token

License

This SDK requires a proper license for use. Please refer to the LICENSE file for details.

---

日本語

機能

• 運転免許証の真贋判定(NFC 読み取り)
• マイナンバーカードの真贋判定(NFC 読み取り)
• 在留カードの真贋判定(NFC 読み取り)
• 顔生体検知
• 顔一致判定

インストール方法

pubspec.yaml に以下を追加：

dependencies:
  ekyc_flutter_sdk: ^1.0.0

依存関係を更新：

flutter pub get

クイックスタート

import 'package:ekyc_flutter_sdk/ekyc_flutter_sdk.dart';

// SDKを初期化
final kycClient = KycApiClient(apiKey: 'YOUR_API_KEY');

// KYCリクエストを作成
final kycRequest = await kycClient.createKycRequest(token: authToken);
final requestId = kycRequest['id'].toString();

// 運転免許証をスキャン
final result = await kycClient.scanDriverLicense(
  pin1: '1234',
  pin2: '5678',
  token: authToken,
  tKycRequestId: requestId,
);

セットアップ

iOS

1. Info.plist に必要な権限を追加：

<key>NFCReaderUsageDescription</key>
<string>このアプリは本人確認書類（運転免許証、マイナンバーカード、在留カード）の読み取りにNFCを使用します。</string>
<key>NSCameraUsageDescription</key>
<string>このアプリは本人確認書類の撮影のためにカメラを使用します。</string>
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
    <string>D2760000850100</string>
    <string>D2760000850101</string>
    <string>D2760001180101</string>
    <!-- その他必要なNFC識別子 -->
</array>

Android

1. AndroidManifest.xml に必要な権限を追加：

<!-- NFC権限 -->
<uses-permission android:name="android.permission.NFC" />
<uses-feature android:name="android.hardware.nfc" android:required="true" />

<!-- カメラ権限 -->
<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="true" />

<!-- アクティビティにNFC検出用の設定を追加 -->
<activity>
    <!-- 既存の設定 -->
    <intent-filter>
        <action android:name="android.nfc.action.TECH_DISCOVERED"/>
        <category android:name="android.intent.category.DEFAULT"/>
    </intent-filter>
    <meta-data
        android:name="android.nfc.action.TECH_DISCOVERED"
        android:resource="@xml/nfc_tech_filter" />
</activity>

サンプルコード

完全な動作例については、example ディレクトリをご参照ください。

必要要件

• iOS 13.0 以上、Android 6.0（API level 23）以上
• NFC ハードウェアが搭載されている端末
• 有効な API キーと認証トークン

ライセンス

本 SDK の使用には適切なライセンスが必要です。詳細については、LICENSE ファイルをご確認ください。