# 同意状況照会API

<br>

## **概要**

同意状況照会APIは、利用者の基本4情報（氏名・住所・生年月日・性別）の提供に関する同意状況を照会するためのAPIです。
サービスプロバイダ事業者は、プラットフォーム事業者を経由してJ-LISへ最新の同意状況を照会します。
これにより、最新の同意状況が確認できます。

## 処理の流れ

<Tabs>
    <Tab title="利用者IDを指定して照会">
        <Steps>
            <Step title="同意状況照会の要求（サービスプロバイダ事業者）">
                取得したい同意状況に対応する利用者IDを指定し、APIでリクエストを送信します。
            </Step>
            <Step title="同意状況の照会（プラットフォーム事業者）">
                受信した利用者IDを基に同意状況照会申請書を生成し、J-LISへ送信し、該当する同意状況データを取得します。
            </Step>
            <Step title="同意状況の返却（プラットフォーム事業者）">
                同意状況の取得が正常に完了した場合は、取得した同意状況データをサービスプロバイダ事業者へ返却します。
            </Step>
        </Steps>
    </Tab>
    <Tab title="検索条件を指定して照会">
        <Steps>
            <Step title="同意状況検索の要求（サービスプロバイダ事業者）">
                取得したい同意状況の期間および署名用電子証明書の種別（マイナンバーカードまたはスマートフォン）を指定し、APIでリクエストを送信します。
            </Step>
            <Step title="同意状況の照会（プラットフォーム事業者）">
                受信した検索条件を基に利用者同意状況照会申請書を生成し、J-LISへ送信し、該当する同意状況データを取得します。
            </Step>
            <Step title="同意状況の返却（プラットフォーム事業者）">
                同意状況の取得が正常に完了した場合は、取得した同意状況データをサービスプロバイダ事業者へ返却します。
            </Step>
        </Steps>
    </Tab>
</Tabs>
    
## **シーケンス図**

<Tabs>
    <Tab title="利用者IDを指定して照会">
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    participant 利用者
    participant SDK
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者
    participant J-LIS

    サービスプロバイダ事業者->>プラットフォーム事業者: 利用者IDの送信
    プラットフォーム事業者->>プラットフォーム事業者:利用者IDに該当する署名用電子証明書を取得 
    プラットフォーム事業者->>J-LIS: 同意状況の照会
    J-LIS->>プラットフォーム事業者: 同意状況の返却
    プラットフォーム事業者->>サービスプロバイダ事業者: 同意状況の返却
```
    </Tab>
    <Tab title="検索条件を指定して照会">
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    participant 利用者
    participant SDK
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者
    participant J-LIS

    サービスプロバイダ事業者->>プラットフォーム事業者:　検索条件を送信
    プラットフォーム事業者->>J-LIS: 同意状況の検索
    J-LIS->>プラットフォーム事業者: 同意状況の返却
    プラットフォーム事業者->>サービスプロバイダ事業者: 同意状況の返却
```
    </Tab>
</Tabs>


<br>