概要 - API Docs

マイナンバーカードの券面事項入力補助APIを用いて、カード券面に記載されている、マイナンバーを除く基本四情報の提供を利用者に要求できるAPIです。

以下のエンドポイントで構成されています。

本エンドポイントを使用することで、マイナンバーカードの券面事項入力補助APIを用いて、当カード券面に記載されている、マイナンバーを除く基本四情報を取得できます。

CardInputについて

主に下記の２点です。

本エンドポイントを用いてCardInputが開始された場合、自動的にxIDアプリへ遷移してプロセスが開始されます。

当プロセスが完了した後、本要求を実行したサービスに自動的に戻ります

xIDアプリから自動遷移して戻る先は、デフォルトブラウザがターゲットとなります。特定のアプリへ遷移が必要な場合は、クライアントアプリ側でユニバーサルリンク、アプリリンクを用いて、そちらをcallback_urlに指定することをご検討ください。

レスポンスに含まれるredirect_urlを呼び出していただくことで、xIDアプリに自動遷移しCardInputプロセスが開始されます。

CardInputのプロセス終了後は、リクエスト時に指定されたURLへ自動遷移いたします。その際、当該手続きのステータスが付与されるので、ステータスに応じてリクエスト元でクライアントに表示する画面を制御することができます。

自動遷移するURLにステータスfulfilledが付与されます。CardInputの詳細情報をCardInputStatusエンドポイントを用いて取得してください。セキュリティの観点から、利用者の個人情報とリクエストの対応状況はそれぞれ切り分けております。