属性連携設定API

「属性連携設定API」とは

1. 概要

マイナポータルから民間送達サービスの情報を取得するためには、「もっとつながる(属性連携サービス)」を使用して、マイナポータルのアカウントと外部のウェブサイトのアカウントの紐付けを行います。
マイナポータルと外部のウェブサイトのアカウントをつなぐ操作を初回のみ行うことで、初回の設定後は、外部のウェブサイトのIDやパスワードを入力することなく、シングルサインオンにてマイナポータルから外部のウェブサイトへシームレスにログインが可能となります。
一方で、マイナポータルAPI経由で民間送達サービス情報を取得する際も同様であり、予め民間送達サービスと属性連携を完了させておくことが必要です。
これまでの「お知らせ情報取得・民間送達サービス保有情報取得API(別ウィンドウ)」(以下、お知らせ/民送情報取得API)は、国民が、予め属性連携を完了させておく前提での利用を想定しておりました。
今後は、民間事業者や国・地方公共団体などのWebサービス提供者が「お知らせ/民送情報取得API(別ウィンドウ)」を使用する際に、「属性連携設定API」及び「利用者登録等API(別ウィンドウ)」を組み合わせてサービスを提供することで、初めてマイナポータルにログインする国民であっても、本人確認・本人同意後に、続けて利用者登録と属性連携を一連の流れで行うことができるようになります。
これにより、国民におけるお知らせ及び民間送達サービス情報の取得がスムーズに進められるようになります。

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

マイナポータルAPIにて提供している「お知らせ/民送情報取得API」を利用して年末調整や確定申告の手続きに必要な証明書等を取得する場合、これまでは「お知らせ/民送情報取得API」のみの提供であったため、国民が予めマイナポータルの属性連携設定を実施済であることを前提としておりました。
そのため、国民がマイナポータルの属性連携設定を実施していない場合は、マイナポータルで属性連携設定を実施してから、再度外部Webサービスを利用する操作としていました。
今後はWebサービス提供者が「属性連携設定API」を「お知らせ/民送情報取得API」と組み合わせて使用することで、外部Webサービスより一連の流れで属性連携設定を行うことができ、国民が外部Webサービスより離脱することなく、サービスの次のステップへ進めることができるようになります。

「属性連携設定API」の利用にあたって

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

API利用の申請

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

質問・お問い合わせ