マイナポータルAPI
属性連携設定API
公開日
更新日
「属性連携設定API」とは
概要
マイナポータルから民間送達サービスの情報を取得するためには、「もっとつながる（属性連携サービス）」を使用して、マイナポータルのアカウントと外部のウェブサイトのアカウントの紐付けを行います。
マイナポータルと外部のウェブサイトのアカウントをつなぐ操作を初回のみ行うことで、初回の設定後は、外部のウェブサイトのIDやパスワードを入力することなく、シングルサインオンにてマイナポータルから外部のウェブサイトへシームレスにログインが可能となります。
一方で、マイナポータルAPI経由で民間送達サービス情報を取得する際も同様であり、予め民間送達サービスと属性連携を完了させておくことが必要です。
これまでの「お知らせ情報取得・民間送達サービス保有情報取得API」（以下、お知らせ／民送情報取得API）は、国民が、予め属性連携を完了させておく前提での利用を想定しておりました。
今後は、民間事業者や国・地方公共団体などのAPIの利用を希望する者が「お知らせ／民送情報取得API」を使用する際に、「属性連携設定API」及び「利用者登録等API」を組み合わせてサービスを提供することで、初めてマイナポータルにログインする国民であっても、本人確認・本人同意後に、続けて利用者登録と属性連携を一連の流れで行うことができるようになります。
これにより、国民におけるお知らせ及び民間送達サービス情報の取得がスムーズに進められるようになります。
想定されるユースケース
マイナポータルAPIにて提供している「お知らせ／民送情報取得API」を利用して年末調整や確定申告の手続きに必要な証明書等を取得する場合、これまでは「お知らせ／民送情報取得API」のみの提供であったため、国民が予めマイナポータルの属性連携設定を実施済であることを前提としておりました。
そのため、国民がマイナポータルの属性連携設定を実施していない場合は、マイナポータルで属性連携設定を実施してから、再度外部Webサービスを利用する操作としていました。
今後はAPIの利用を希望する者が「属性連携設定API」を「お知らせ／民送情報取得API」と組み合わせて使用することで、外部Webサービスより一連の流れで属性連携設定を行うことができ、国民が外部Webサービスより離脱することなく、サービスの次のステップへ進めることができるようになります。
活用事例
属性連携設定APIを活用している事例を公開しています。
「属性連携設定API」の利用にあたって
はじめに、属性連携設定API利用ガイドライン（PDF／1,286KB）を参照し、APIの利用について事業者内で検討してください。
APIの利用を開始するためには、本サイトにて利用規約（PDF／359KB）をご確認のうえ、API利用申請フォームから仕様書の取得申請を行い、属性連携設定APIと組み合わせて利用するAPIの利用開始フローに沿って手続きを進めてください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。
APIの利用申請
以下の流れに沿って、APIの利用を申請してください。
利用申請手続き
1．必要書類の確認
はじめに、属性連携設定API利用ガイドライン、利用規約を確認し、仕様書取得を行ってAPIの利用について検討してください。
属性連携設定API利用ガイドライン（PDF／1,286KB）
利用規約（PDF／359KB）
仕様書の事前取得
仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請
2．組み合わせて利用するAPIを検討
属性連携設定APIは単独では利用できません。
属性連携設定APIを利用するためには利用者登録等APIの併用が必要です。利用者登録等APIについて確認してください。
利用者登録等API
また、以下のAPIと組み合わせて利用できます。
組み合わせて利用するAPIのページから必要書類を確認し、あわせて利用申請をしてください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
お知らせ情報取得・民間送達サービス保有情報取得API
自己情報取得API
医療保険情報取得API
よくある質問・お問合せ
※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。