必要なOAuthスコープ:
accounts_read
アカウントグループとは
Moneytreeが対応する金融サービスによって、一回の登録により、複数の口座情報が取得されることがあります。
例えば、銀行口座では、一回の登録により、普通預金だけでなく、定期預金、カードローンなども取得される場合や、クレジットカードにおいては、カードのポイントプログラムなどです。
カードとポイントはそれぞれのアカウントとしてMoneytreeにデータが格納されますが、account groupが同じであれば、これらは同じ登録により取得されたものであると判別できます。
こうした、Moneytreeに登録する金融サービスの認証ごとのまとまりを、Moneytreeではaccount groupと呼び、MT LINK API（本API、および各account API）でその情報を提供しています。
アカウントグループの状態について
「個人口座」、「法人口座」、「投資用口座」、および「ポイント」など、ゲストユーザー様が登録している様々な金融サービスのアカウントグループの状態を本APIで一括で取得できます。
そのため、同期依頼APIなどで処理の状況、完了を確認するために利用できます。
さらに、金融サービスを登録した直後では、正常に登録処理が完了するまで、各account APIで口座情報は返されません。
こうした口座にたいしても本APIはオブジェクトを返します。
本APIでオブジェクトが返され、各account APIで返されないのは、主に以下の２つのケースがあります。
- 金融サービスは無事に登録されたが、まだ完全にすべての情報の取得がまだ終わっていないため、口座情報がまだ返されない。
- 金融サービスの登録そのものが正常に完了しておらず、認証エラーや追加認証などが必要な状態であり、Moneytreeにデータが存在しない。
本APIは、こうした口座を判定するための手段に利用できるものです。つまり、last_aggregated_atがnullの場合は、登録が完了してない金融サービス
（登録中、または初期登録において処理が完了していない）と判定し、処理の完了を待つ、または、ゲストユーザーに再認証を促すことが可能です。