利用者登録等API

「利用者登録等API」とは

概要

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

想定されるユースケース

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

活用事例

利用者登録等APIを活用している事例を公開しています。

活用事例の一覧を見る

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

はじめに、利用者登録等API利用ガイドライン（PDF／1,092KB）を参照し、APIの利用について事業者内で検討してください。
APIの利用を開始するためには、本サイトにて利用規約（PDF／359KB）をご確認のうえ、API利用申請フォームから仕様書の取得申請を行い、利用者登録等APIと組み合わせて利用するAPIの利用開始フローに沿って手続きを進めてください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。

APIの利用申請

以下の流れに沿って、APIの利用を申請してください。

よくある質問・お問合せ

• よくある質問をご確認ください。
• 上記「よくある質問」で解決しない場合は、お問合せにてご連絡ください。

※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。

関連コンテンツ

• メンテナンス・稼働状況