利用者登録等API

「利用者登録等API」とは

1. 概要

国民がマイナポータルを初めて利用する際は、最初の手順として利用者登録を行い、アカウントを作成します。利用者登録が完了すると、様々なサービスを利用することができるようになります。
マイナポータルAPI経由でマイナポータルのサービスを利用する際も同様であり、初めて利用する際は、予め利用者登録を完了させておくことが必要です。
そのため、民間事業者や国・地方公共団体などのWebサービス提供者はサービスで利用するAPI(例えば、「お知らせ情報取得・民間送達サービス保有情報取得API(別ウィンドウ)」(以下、お知らせ/民送情報取得API))と「利用者登録等API」を組み合わせてサービスを提供することで、初めてマイナポータルを利用する国民であっても、本人確認・本人同意後に、続けて利用者登録を行うことができ、国・地方公共団体より提供されるお知らせ情報をスムーズに取得することができるようになります。
なお、お知らせ情報は、マイナポータルの利用者登録後に利用できるサービスのため、特に利用が想定される例として挙げていますが、マイナポータルのその他のサービス(機能)を利用する際にも、利用者登録等APIをご利用いただくことで、円滑にサービス利用につなげることができます。

2. 想定されるユースケース

Webサービス提供者が外部Webサービスを利用する国民に、「お知らせ/民送情報取得API」を利用いただきたい場合、これまでは「お知らせ/民送情報取得API」のみの提供であったため、国民が予めマイナポータルの利用者登録を完了していることを前提としていました。
そのため、国民がマイナポータルの利用者登録を実施していない場合は、一度、外部Webサービスから離れてマイナポータルで利用者登録を実施してから、再度外部Webサービスを利用する操作としておりました。
今後は、Webサービス提供者が「利用者登録等API」を「お知らせ/民送情報取得API」と組み合わせて使用することで、外部Webサービスより一連の流れで利用者登録を行うことができ、国民が外部Webサービスより離れることなく、サービスの次のステップへ進めることができるようになります。

「利用者登録等API」の利用にあたって

はじめに、「利用者登録等API利用ガイドライン(別ウィンドウ)」を参照し、APIの利用について、事業者内で検討してください。なお、利用検討にあたり疑問等が生じた際は、随時本サイトの問合せフォーム(別ウィンドウ)にて、疑問点をお問い合わせください。
利用の意思及び内容が概ね固まったら、事前打合せ資料一式(別ウィンドウ)をダウンロードの上、利用者登録等APIと同時に利用予定のAPIの利用開始フローに沿って手続きを進めてください。

API利用の申請

はじめに、「利用者登録等API利用ガイドライン・利用規約」を参照し、APIの利用について、事業者内で検討してください。
利用者登録等APIは、単独で使用することはできません。利用目的に沿った他のAPIについて必要書類を作成し、事前打合せを申請してください。

質問・お問い合わせ