本文へ移動

マイナポータルAPI

利用者登録等API

公開日

更新日

「利用者登録等API」とは

概要

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

利用者登録等APIの連携フロー図。マイナポータルを初めて利用する国民は、利用者登録が必要なため、まず本人がマイナンバーカードで本人確認と同意を行う。次にWebサービスが利用者登録等APIを使用して国民のマイナポータル利用状態確認を依頼する。依頼されたマイナポータルは情報提供ネットワークシステムや住民基本台帳ネットワークシステム利用者登録により本人認証を行ったのち、マイナポータルへの利用者登録を実施。

想定されるユースケース

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

サービスに利用者登録APIを組み込む前と組み込んだ後のサービス利用者の体験を比較した図。図の詳細は、画像の直前のテキストで説明。

活用事例

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

株式会社Dental Prediction「歯科まもる健康手帳」
株式会社Dental Prediction「歯科まもる健康手帳」

【健康・医療】「歯科まもる健康手帳」は、生涯のお口の健康づくりをサポートするアプリです。マイナポータルと連携することで、歯周疾患検診情報、医療費通知情報、薬剤情報等および健診情報を「お口の健康手帳」機能で管理したり、それらの情報を参考に歯科医師に健康相談をしたりすることができます。(利用API:自己情報取得API、医療保険情報取得API、利用者登録等API)

3Hメディソリューション株式会社「生活向上WEB」
3Hメディソリューション株式会社「生活向上WEB」

【健康・医療】生活向上WEBのマイカルテは、マイナポータルから取得した健診情報や薬剤情報を一元管理できるツールです。健康状態の推移を正確に把握することで、生活習慣の振り返りに活用できます。また、利用者が自身の正確なデータを参照しながら、適切な医療情報や治験情報を円滑に確認できます。(利用API:自己情報取得API、医療保険情報取得API、利用者登録等API)

千葉県「千葉県奨学のための給付金電子申請サービス」
千葉県「千葉県奨学のための給付金電子申請サービス」

【教育】対象者(県民)が、千葉県奨学のための給付金電子申請サービスから、電子申請を行うことで、紙の申請書を記載する手間や、収入証明書等の添付書類を取得する手間を省くことができるサービスです。(利用API:自己情報取得API、利用者登録等API)

活用事例の一覧を見る

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

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

APIの利用申請

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

利用申請手続き

1.必要書類の確認

はじめに、利用者登録等API利用ガイドライン、利用規約を確認し、仕様書取得を行ってAPIの利用について検討してください。
利用者登録等API利用ガイドライン(PDF/1,092KB)
利用規約(PDF/359KB)

仕様書の事前取得

仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請

2.組み合わせて利用するAPIを検討

利用者登録等APIは単独では利用できません。以下から組み合わせて利用するAPIを選択してください。
組み合わせて利用するAPIのページから必要書類を確認し、あわせて利用申請をしてください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
自己情報取得API
医療保険情報取得API
PMH情報連携API
お知らせ情報取得・民間送達サービス保有情報取得API
属性連携設定API

よくある質問・お問合せ

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

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

関連コンテンツ