# マイナアプリ 署名API

<br>

## **概要**
    
マイナアプリ署名APIは、インターネット等で利用者が作成・送信した電子文書が「利用者が作成した真正なものであり、利用者が送信したものであること」を確かめるためのAPIです。
マイナンバーカードのICチップから署名用電子証明書を読み取り、利用者によって作成された電子文書を秘密鍵を使用して暗号化することで電子署名を生成します。
これにより、受領した電子文書の利用者の実在性、氏名・住所等を正確・確実に把握し、かつ、改ざんや送信否認のおそれがないものとして申請書等を安心して受け取ることができます。券面事項入力補助APIを用いた基本4情報連携機能も利用可能です。

:::caution[]
券面事項入力補助APIによる基本4情報連携を利用される場合は、別途料金がかかります。
:::

## **アクセスコントロール**

<AccordionGroup>
    <Accordion title="マイナンバーカード">
        署名用電子証明書の暗証番号（6〜16桁の半角英数字）
        
:::caution[]
5回連続で署名用電子証明書の暗証番号を間違えた場合には、マイナンバーカードにロックがかかってしまいますのでご注意ください。       
:::
    </Accordion>
    <Accordion title="スマートフォンのマイナンバーカード">
        署名用電子証明書の暗証番号（6〜16桁の半角英数字）
:::caution[]
5回連続で署名用電子証明書の暗証番号を間違えた場合には、マイナンバーカードにロックがかかってしまいますのでご注意ください。       
:::
    </Accordion>
 </AccordionGroup>


## **処理の流れ**


<Tabs>
  <Tab title="対面">
     
<Steps>
    <Step title="署名の要求（サービスプロバイダ事業者）">
        契約書や申し込み情報など、署名対象となる電子文書からハッシュ値を生成し、Base64形式にエンコードします。生成した署名対象データ、リダイレクト先URL、券面事項入力補助APIより取得する基本4情報の項目をAPIに送信します。
    </Step>
    <Step title="署名トランザクションの開始（プラットフォーム事業者）">
        受信した署名対象データをもとに署名トランザクションを開始します。正常に開始された場合、サービスプロバイダ事業者にマイナアプリ用の署名用URLを返却します。
    </Step>
    <Step title="マイナアプリの起動（サービスプロバイダ事業者）">
        受信した署名用URLにアクセスすることで、利用者のスマートフォンでマイナアプリが起動します。PCまたはタブレットの場合は、認証用のQRコードがブラウザやアプリ画面に表示されますので、利用者はマイナアプリの「二次元コードを読み取る」をタップすることでカメラを起動し、表示されたQRコードを読み取ることで、マイナアプリに表示された6桁のパスコードをPCまたはタブレットの画面で入力します。
    </Step>
    <Step title="署名値の生成（サービスプロバイダ事業者）">
        利用者は画面の案内に従って操作を行い、署名対象データをもとに署名値を生成します。署名完了後、リダイレクトにより署名結果パラメータをAPIへ送信します。
        <AccordionGroup>
            <Accordion title="マイナンバーカードを読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「ほかの方法を選ぶ」を選択します。</Step>
                    <Step>「実物のマイナンバーカード」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。基本4情報も取得する場合は、続けて4桁の券面事項入力補助のパスワードを入力します。</Step>
                    <Step>「読み取り開始」をタップし、NFC機能でマイナンバーカードを読み取ることで署名が完了します。</Step>
                </Steps>
            </Accordion>
            <Accordion title="iPhoneのマイナンバーカードを読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「iPhoneのマイナンバーカード」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。基本4情報も取得する場合は、続けてAppleウォレットが起動し、マイナアプリに対する基本4情報共有を確認されるので、電源ボタンをダブルタップすることで承認します。</Step>
                    <Step>入力したパスワードに問題なければ、署名が完了します。なお、基本4情報を取得する場合は、Appleウォレットの承認も正常に完了する必要があります。</Step>
                </Steps>
            </Accordion>
            <Accordion title="Androidスマホ用電子証明書を読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「スマホ用電子証明書」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。</Step>
                    <Step>入力したパスワードに問題なければ、署名が完了します。</Step>

                </Steps>
:::caution[]
現時点でAndroidスマホ用電子証明書では、基本4情報の取得に対して非対応のため、基本4情報の取得をご希望の場合は、マイナンバーカードをご利用ください。
:::
            </Accordion>
        </AccordionGroup>
    </Step>
    <Step title="CSRF対策検証（プラットフォーム事業者）">
        リダイレクトで受信したデータをもとに、CSRF攻撃の有無を検証します。攻撃が検知された場合は、認証処理を中断しエラーを返却します。
    </Step>
    <Step title="署名トランザクション結果の取得（プラットフォーム事業者）">
        検証が正常に完了した場合、マイナアプリで生成された署名結果を取得します。取得した内容に異常がある場合は、エラーを返却し処理を中断します。
    </Step>
    <Step title="署名検証・有効性確認（プラットフォーム事業者）">
        取得した署名結果を使用して、署名検証および署名用電子証明書の有効性確認を行います。これらの結果は証跡としてプラットフォーム事業者のデータベースに保存・管理されます。なお、有効性確認はCRLを利用して行います。
    </Step>
    <Step title="署名トランザクションIDの返却（プラットフォーム事業者）">
        署名検証および有効性確認が正常に完了した場合、署名トランザクションIDをリダイレクトで返却し、署名完了画面へ遷移します。
    </Step>
    <Step title="署名検証結果の取得（サービスプロバイダ事業者）">
        取得した署名トランザクションIDをAPIに送信することで、利用者識別ID、基本4情報、署名検証結果が返却されます。
    </Step>
</Steps>
      
  </Tab>
  <Tab title="非対面">
<Steps>
    <Step title="署名の要求（サービスプロバイダ事業者）">
        契約書や申し込み情報など、署名対象となる電子文書からハッシュ値を生成し、Base64形式にエンコードします。生成した署名対象データ、リダイレクト先URL、券面事項入力補助APIより取得する基本4情報の項目をAPIに送信します。
    </Step>
    <Step title="署名トランザクションの開始（プラットフォーム事業者）">
        受信した署名対象データをもとに署名トランザクションを開始します。正常に開始された場合、サービスプロバイダ事業者にマイナアプリ用の署名用URLを返却します。
    </Step>
    <Step title="マイナアプリの起動（サービスプロバイダ事業者）">
        受信した署名用URLにアクセスすることで、利用者のスマートフォンでマイナアプリが起動します。PCまたはタブレットの場合は、認証用のQRコードがブラウザやアプリ画面に表示されますので、利用者はマイナアプリの「二次元コードを読み取る」をタップすることでカメラを起動し、表示されたQRコードを読み取ることで、マイナアプリに表示された6桁のパスコードをPCまたはタブレットの画面で入力します。
    </Step>
    <Step title="署名値の生成（サービスプロバイダ事業者）">
        利用者は画面の案内に従って操作を行い、署名対象データをもとに署名値を生成します。署名完了後、リダイレクトにより署名結果パラメータをAPIへ送信します。
        <AccordionGroup>
            <Accordion title="マイナンバーカードを読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「ほかの方法を選ぶ」を選択します。</Step>
                    <Step>「実物のマイナンバーカード」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。基本4情報も取得する場合は、続けて4桁の券面事項入力補助のパスワードを入力します。</Step>
                    <Step>「読み取り開始」をタップし、NFC機能でマイナンバーカードを読み取ることで署名が完了します。</Step>
                </Steps>
            </Accordion>
            <Accordion title="iPhoneのマイナンバーカードを読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「iPhoneのマイナンバーカード」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。基本4情報も取得する場合は、続けてAppleウォレットが起動し、マイナアプリに対する基本4情報共有を確認されるので、電源ボタンをダブルタップすることで承認します。</Step>
                    <Step>入力したパスワードに問題なければ、署名が完了します。なお、基本4情報を取得する場合は、Appleウォレットの承認も正常に完了する必要があります。</Step>
                </Steps>
            </Accordion>
            <Accordion title="Androidスマホ用電子証明書を読み取る">
                <Steps>
                    <Step>「マイナンバーカードを使って署名します」画面の「スマホ用電子証明書」を選択します。</Step>
                    <Step>PCまたはタブレットの場合のみ、マイナアプリ画面に6桁のパスコードが表示されますので、PCまたはタブレットに表示されているパスコード入力欄に入力します。</Step>
                    <Step>署名対象の内容が画面に表示されるので、内容を確認後、「確認して次へ」をタップします。</Step>
                    <Step>6〜16桁の署名用電子証明書のパスワードを入力し、「次へ」をタップします。</Step>
                    <Step>入力したパスワードに問題なければ、署名が完了します。</Step>

                </Steps>
:::caution[]
現時点でAndroidスマホ用電子証明書では、基本4情報の取得に対して非対応のため、基本4情報の取得をご希望の場合は、マイナンバーカードをご利用ください。
:::
            </Accordion>
        </AccordionGroup>
    </Step>
    <Step title="CSRF対策検証（プラットフォーム事業者）">
        リダイレクトで受信したデータをもとに、CSRF攻撃の有無を検証します。攻撃が検知された場合は、認証処理を中断しエラーを返却します。
    </Step>
    <Step title="署名トランザクション結果の取得（プラットフォーム事業者）">
        検証が正常に完了した場合、マイナアプリで生成された署名結果を取得します。取得した内容に異常がある場合は、エラーを返却し処理を中断します。
    </Step>
    <Step title="署名検証・有効性確認（プラットフォーム事業者）">
        取得した署名結果を使用して、署名検証および署名用電子証明書の有効性確認を行います。これらの結果は証跡としてプラットフォーム事業者のデータベースに保存・管理されます。なお、有効性確認はCRLを利用して行います。
    </Step>
    <Step title="署名トランザクションIDの返却（プラットフォーム事業者）">
        署名検証および有効性確認が正常に完了した場合、署名トランザクションIDをリダイレクトで返却し、署名完了画面へ遷移します。
    </Step>
    <Step title="署名検証結果の取得（サービスプロバイダ事業者）">
        取得した署名トランザクションIDをAPIに送信することで、利用者識別ID、基本4情報、署名検証結果が返却されます。
    </Step>
</Steps>
      
  </Tab>
</Tabs>


## **シーケンス図**

<Tabs>
  <Tab title="対面">
    
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    autonumber
    participant 利用者
    participant マイナアプリ
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者
    participant デジタル庁サーバ
    participant J-LIS

    利用者->>サービスプロバイダ事業者: [01] 「はじめる」押下
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:1.署名の要求
    サービスプロバイダ事業者->>プラットフォーム事業者: [02] 署名の要求
    プラットフォーム事業者->>プラットフォーム事業者: [03] 署名対象ハッシュ値生成
    プラットフォーム事業者->>デジタル庁サーバ: [04] トークンリクエスト（client_credentials）
    デジタル庁サーバ-->>プラットフォーム事業者: [05] トークンレスポンス（client_credentials）
    Note Over プラットフォーム事業者,デジタル庁サーバ:2.署名トランザクションの開始
    プラットフォーム事業者->>デジタル庁サーバ: [06] 署名トランザクション開始リクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [07] 署名トランザクション開始レスポンス
    プラットフォーム事業者-->>サービスプロバイダ事業者: 署名用URLの返却
    Note Over 利用者,サービスプロバイダ事業者:3.マイナアプリの起動
    alt スマートフォン（同一端末）
        サービスプロバイダ事業者->>マイナアプリ: [08] 認可リクエスト [09] リダイレクト
        マイナアプリ->>利用者: マイナアプリ起動
    else PC・タブレット（別端末）
        サービスプロバイダ事業者->>マイナアプリ: [08] 認可リクエスト [09] リダイレクト（QRコード表示）
        マイナアプリ->>利用者: マイナアプリ起動<br>QRコードの読み取り・パスコード認証
    end
    Note Over 利用者,デジタル庁サーバ:4.署名値の生成
    利用者->>利用者: マイナアプリの操作
    利用者->>マイナアプリ: 署名用電子証明書の読み取り<br>暗証番号の入力
    マイナアプリ->>マイナアプリ: [10] 利用者が署名対象ハッシュ値に署名
    マイナアプリ->>デジタル庁サーバ: 署名完了
    Note Over プラットフォーム事業者,デジタル庁サーバ:5.CSRF対策検証
    デジタル庁サーバ->>プラットフォーム事業者: [11] 認可レスポンス [12] リダイレクト
    プラットフォーム事業者->>デジタル庁サーバ: [13] トークンリクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [14] トークンレスポンス
    Note Over プラットフォーム事業者,デジタル庁サーバ:6.署名トランザクション結果の取得
    プラットフォーム事業者->>デジタル庁サーバ: [16] 署名トランザクション結果取得リクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [17] 署名トランザクション結果取得レスポンス
    プラットフォーム事業者->>デジタル庁サーバ: [18] UserInfoリクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [19] UserInfoレスポンス
    
    Note Over プラットフォーム事業者:7.署名検証・有効性確認
    プラットフォーム事業者->>プラットフォーム事業者: 署名検証
    プラットフォーム事業者->>プラットフォーム事業者: CRLによる有効性確認
    プラットフォーム事業者->プラットフォーム事業者: 証跡の保存
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:8.署名トランザクションIDの返却
    プラットフォーム事業者->>サービスプロバイダ事業者: [20] レスポンス<br>（リダイレクトで署名トランザクションIDを返却）
    サービスプロバイダ事業者->>プラットフォーム事業者: 署名トランザクションIDを送信
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:9.署名検証結果の取得
    
    プラットフォーム事業者-->>サービスプロバイダ事業者: 基本4情報・署名検証結果の返却
```
  </Tab>
  <Tab title="非対面">
    
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    autonumber
    participant 利用者
    participant マイナアプリ
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者
    participant デジタル庁サーバ
    participant J-LIS

    利用者->>サービスプロバイダ事業者: [01] 「はじめる」押下
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:1.署名の要求
    サービスプロバイダ事業者->>プラットフォーム事業者: [02] 署名の要求
    プラットフォーム事業者->>プラットフォーム事業者: [03] 署名対象ハッシュ値生成
    プラットフォーム事業者->>デジタル庁サーバ: [04] トークンリクエスト（client_credentials）
    デジタル庁サーバ-->>プラットフォーム事業者: [05] トークンレスポンス（client_credentials）
    Note Over プラットフォーム事業者,デジタル庁サーバ:2.署名トランザクションの開始
    プラットフォーム事業者->>デジタル庁サーバ: [06] 署名トランザクション開始リクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [07] 署名トランザクション開始レスポンス
    プラットフォーム事業者-->>サービスプロバイダ事業者: 署名用URLの返却
    Note Over 利用者,サービスプロバイダ事業者:3.マイナアプリの起動
    alt スマートフォン（同一端末）
        サービスプロバイダ事業者->>マイナアプリ: [08] 認可リクエスト [09] リダイレクト
        マイナアプリ->>利用者: マイナアプリ起動
    else PC・タブレット（別端末）
        サービスプロバイダ事業者->>マイナアプリ: [08] 認可リクエスト [09] リダイレクト（QRコード表示）
        マイナアプリ->>利用者: マイナアプリ起動<br>QRコードの読み取り・パスコード認証
    end
    Note Over 利用者,デジタル庁サーバ:4.署名値の生成
    利用者->>利用者: マイナアプリの操作
    利用者->>マイナアプリ: 署名用電子証明書の読み取り<br>暗証番号の入力
    マイナアプリ->>マイナアプリ: [10] 利用者が署名対象ハッシュ値に署名
    マイナアプリ->>デジタル庁サーバ: 署名完了
    Note Over プラットフォーム事業者,デジタル庁サーバ:5.CSRF対策検証
    デジタル庁サーバ->>プラットフォーム事業者: [11] 認可レスポンス [12] リダイレクト
    プラットフォーム事業者->>デジタル庁サーバ: [13] トークンリクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [14] トークンレスポンス
    Note Over プラットフォーム事業者,デジタル庁サーバ:6.署名トランザクション結果の取得
    プラットフォーム事業者->>デジタル庁サーバ: [16] 署名トランザクション結果取得リクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [17] 署名トランザクション結果取得レスポンス
    プラットフォーム事業者->>デジタル庁サーバ: [18] UserInfoリクエスト
    デジタル庁サーバ-->>プラットフォーム事業者: [19] UserInfoレスポンス
    
    Note Over プラットフォーム事業者:7.署名検証・有効性確認
    プラットフォーム事業者->>プラットフォーム事業者: 署名検証
    プラットフォーム事業者->>プラットフォーム事業者: CRLによる有効性確認
    プラットフォーム事業者->プラットフォーム事業者: 証跡の保存
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:8.署名トランザクションIDの返却
    プラットフォーム事業者->>サービスプロバイダ事業者: [20] レスポンス<br>（リダイレクトで署名トランザクションIDを返却）
    サービスプロバイダ事業者->>プラットフォーム事業者: 署名トランザクションIDを送信
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:9.署名検証結果の取得
    
    プラットフォーム事業者-->>サービスプロバイダ事業者: 基本4情報・署名検証結果の返却
```
  </Tab>
</Tabs>



<br>