Primagest Trust Services
プロダクトドキュメントよくあるご質問
運営会社リリースノート
プロダクトドキュメントよくあるご質問
運営会社リリースノート
APIリファレンス
  1. 共通質問
  • カテゴリ
  • 共通質問
    • APIに関する共通質問
    • SDKに関する共通質問
  • 本人確認
    • カード代替電磁的記録
    • 公的個人認証
    • ICチップ読み取り+容貌撮影
    • ICチップ読み取り
  • 本人情報取得
    • 基本4情報提供
  • 連携プロダクト
    • マイナアプリ
  • SDK
    • 技術的な質問
  • 本人確認サービス
    • 対面本人確認アプリ
    • 非対面本人確認アプリ
  • 管理コンソール
    • 管理者・メンバー
    • パスキー
  • 申込み・支払い・解約
    • 申込み
    • 支払い・解約
  • サポート・セキュリティ
    • セキュリティ・データ管理
    • お問い合わせ・障害対応
  1. 共通質問

SDKに関する共通質問


SDKに関する共通のよくある質問はこちらになります。

提供形態・システム構成#

SDKはどのような形態で提供されますか?
SDKは、契約後に管理コンソールの「SDKパッケージ」から発行する認証情報を用いて、弊社パッケージリポジトリから取得します。
iOSはSwift Package Manager、AndroidはMaven、WindowsはNuGet、React Nativeはnpmで提供しています。
詳細な導入手順はSDKページおよび契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
SDKを利用する際のシステム構成について教えてください。
標準的な構成は、お客様のアプリ・システムにSDKを組み込み、SDKを利用してICチップから読み取ったデータをお客様のサーバーへ送信し、サーバーから対応するAPIを呼び出す構成です。APIキーはアプリ側に保持せず、お客様のサーバーで管理してください。
本人確認アプリサービスをご利用の場合は、弊社提供アプリと管理コンソールを中心とした構成となるため、API・SDKの組み込みは不要です。
詳細はドキュメントをご確認ください。
本人確認API →
本人情報取得API →
SDKを利用するために、アプリ側ではどのような実装が必要ですか?
アプリ側では、利用するSDKの組み込み、NFC・カメラ等の権限設定、カード読み取り、および読み取りデータの自社サーバーへの送信が必要です。
APIの呼び出しはお客様のサーバー側で行い、APIキーはアプリケーションに埋め込まないでください。具体的な実装手順は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
SDKでICチップから読み出したデータを、APIへ送信せずそのまま利用できますか?
SDKでICチップから読み出したデータは、そのままでは利用できません。
該当するAPIへ送信し、処理を行うことで利用可能なデータとなります。
本人確認サービスを利用する場合、SDKの組み込みは必要ですか?
本人確認サービスをご利用の場合は、プリマジェスト提供アプリ(対面本人確認アプリ・非対面本人確認アプリ)と管理コンソールを中心とした構成となるため、SDKの組み込みは不要です。
API・SDKをお客様のシステムへ組み込む方式とは別の選択肢としてご利用いただけます。
本人確認サービス →
マイナンバーカードのテストカードを借りることはできますか?
当社へご来訪いただく場合に限り、テストカードの貸与に対応しています。
貸与できる枚数や時間には限りがあるため、事前に弊社担当者またはサポート窓口までご相談ください。

対応環境#

対応しているOSを教えてください。
SDKは、iOS、Android、Windows向けに提供しています。
詳細な対応環境・技術仕様については、契約後に閲覧権限が付与されるAPIリファレンスのSDKページをご確認ください。
対応している開発言語・フレームワークを教えてください。
iOSはSwift、AndroidはKotlin / Java、React NativeはReact Native(Expo)、WindowsはC / C++ / C#に対応しています。
詳細な対応バージョンや実装仕様については、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
SDKを利用するために、端末側で必要な機能はありますか?
必要な端末機能は、利用するサービス・機能によって異なります。
・ICチップ読み取りを行う場合は、NFC(iOS / Android)またはPC/SC対応のICカードリーダー(Windows)が必要です。
・iOSはiOS 16以降のNFC搭載端末、AndroidはAndroid 10(API 29)以降のNFC搭載端末、WindowsはWindows 10 / 11(x64)を想定しています。
・券面OCRや容貌撮影を利用する場合はカメラ、スマートフォンのマイナンバーカード(カード代替電磁的記録)を利用する場合はBluetoothが必要です。
NFC読み取りには実機が必要で、シミュレータ・エミュレータでは動作しません。
詳細な導入手順は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

バージョン・更新情報#

SDKのバージョン管理や互換性について教えてください。
SDKのバージョンや対応状況は更新される場合があります。
最新情報はSDKページ、詳細なバージョン・互換性については契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
SDKの更新はどのように行われますか?
SDKはバージョン管理されており、新しいバージョンは弊社パッケージリポジトリで公開します。
お客様側で依存バージョンを更新してご利用ください。
最新情報はSDKページおよび契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
SDKの変更履歴はどこで確認できますか?
現在準備中のリリースノートよりご確認いただけます。ドキュメントより公開する予定のため、追ってお知らせいたします。
また、重要な仕様変更やアップデートについては、お客様へ随時お知らせします。
SDKの実装サンプルはありますか?
2026年10月時点で、Windowsの実装サンプルコードのみ提供しています。今後iOS、Androidの実装サンプルコードも提供予定です。

エラー・トラブルシューティング#

SDKの組み込みやビルドでエラーが発生した場合はどうすればよいですか?
利用しているSDKのバージョン、OS・開発環境の対応状況、導入手順、依存関係等をご確認ください。
解決しない場合は、OS、開発環境、SDKバージョン、エラー内容等を添えてテックサポート窓口までお問い合わせください。
お問い合わせ →
ICカードの読み取りで発生したエラーはSDKのみで取得できますか?
デバイス側で発生するエラーについては、APIを呼び出すことなくSDKのみで取得できます。一方、NFCで取得したデータをAPIへ送信した後に発生するエラー(データのパース失敗、不正なデータ等)はAPI側で判定されるため、APIへ送信しない限り取得できません。

解決しない場合は#

解決しないご質問や、サービスの導入・ご利用に関するご相談がございましたら、お気軽にお問い合わせください。
お問い合わせ

前へ
APIに関する共通質問
次へ
カード代替電磁的記録
Built with