# 確認記録取得API

<br>

## **概要**

本人確認記録取得APIは、本人確認アプリで実施・完了した本人確認の記録を確認・取得するAPIです。
プラットフォーム事業者には、本人確認が完了した後に、検証結果（真贋判定・失効確認・有効期限の判定）や、本人確認書類から取得した情報（氏名・住所・生年月日・顔写真など。書類種別により異なります）が「本人確認記録」として保管されます。
なお、保管される情報は本人確認時に取得・保存した内容のみで、含まれる項目は本人確認に使用した書類の種別と取得項目の設定によって異なります。
これらの本人確認記録は、実施した本人確認の内容や真正性を後から確認・証明するための根拠となります。
サービスプロバイダ事業者は必要に応じてこれらの本人確認記録を照会し、JSON形式で取得することが可能です。

## **処理の流れ**

<Tabs>
    <Tab title="本人確認記録IDを指定して照会">
        <Steps>
            <Step title="本人確認記録照会の要求（サービスプロバイダ事業者）">
                取得したい本人確認記録IDを指定し、APIでリクエストを送信します。取得できる記録の内容は次のとおりです。
                - 検証結果（真贋判定・失効確認・有効期限の判定と総合判定）
                - 本人確認書類から取得した情報
                  - 公的個人認証の場合、署名検証・失効確認の結果・電子証明書の有効期間・発行者・基本4情報
                  - 券面事項・運転免許証・在留カード・特別永住者証明書などの場合、顔写真・氏名・住所・生年月日などの券面情報
            </Step>
            <Step title="本人確認記録データの取得（プラットフォーム事業者）">
                条件に該当する本人確認記録をデータベースから取得します。
            </Step>
            <Step title="本人確認記録データの返却（プラットフォーム事業者）">
                取得した本人確認記録データをJSON形式でサービスプロバイダ事業者へ返却します。
            </Step>
        </Steps>
    </Tab>
    <Tab title="検索条件を指定して照会">
        <Steps>
            <Step title="本人確認記録照会の要求（サービスプロバイダ事業者）">
                取得したい本人確認記録の期間（本人確認完了日時）を含む検索条件を指定し、APIでリクエストを送信します。検索条件は、後述の「検索条件と取得できる本人確認記録」に記載のとおり、組み合わせて指定できます。取得できる記録の内容は次のとおりです。
                - 検証結果（真贋判定・失効確認・有効期限の判定と総合判定）
                - 本人確認書類から取得した情報
                  - 公的個人認証の場合、署名検証・失効確認の結果・電子証明書の有効期間・発行者・基本4情報
                  - 券面事項・運転免許証・在留カード・特別永住者証明書などの場合、顔写真・氏名・住所・生年月日などの券面情報
            </Step>
            <Step title="本人確認記録データの取得（プラットフォーム事業者）">
                条件に該当する本人確認記録をデータベースから検索・取得します。
            </Step>
            <Step title="本人確認記録データの返却（プラットフォーム事業者）">
                取得した本人確認記録データを本人確認完了日時の昇順で、JSON形式でサービスプロバイダ事業者へ返却します。1回のレスポンスで返却する件数には上限があるため、続きがある場合はレスポンスに含まれるカーソルを指定して再度リクエストします。
            </Step>
        </Steps>
    </Tab>
</Tabs>

## **検索条件と取得できる本人確認記録**

<Tabs>
    <Tab title="本人確認記録IDを指定">
        <AccordionGroup>
            <Accordion title="本人確認記録ID">
                指定したIDの本人確認記録1件（検証結果・本人確認書類から取得した情報）。本人確認記録IDは、本人確認の完了時に発行されるIDまたは本APIの検索結果で得られる値です。
            </Accordion>
        </AccordionGroup>
    </Tab>
    <Tab title="検索条件を指定">
        次の検索条件は組み合わせて指定できます。いずれの条件もすべての条件に一致した本人確認記録（検証結果・本人確認書類から取得した情報）が返却されます。
        <AccordionGroup>
            <Accordion title="本人確認完了日時の期間">
                指定した期間内に完了した本人確認記録
            </Accordion>
            <Accordion title="実施形式">
                指定した実施形式（対面・非対面・非対面PUSH）で実施した本人確認記録
            </Accordion>
            <Accordion title="書類種別">
                指定した本人確認書類（マイナンバーカード〈公的個人認証・券面事項〉・運転免許証・在留カード・特別永住者証明書）で実施した本人確認記録
            </Accordion>
            <Accordion title="本人確認記録ID（複数指定）">
                指定したID（最大100件）に一致する本人確認記録
            </Accordion>
        </AccordionGroup>
    </Tab>
</Tabs>

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

<Tabs>
    <Tab title="本人確認記録IDを指定して照会">
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    autonumber
    participant 利用者
    participant 本人確認アプリ
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者

    Note Over サービスプロバイダ事業者,プラットフォーム事業者:1.本人確認記録照会の要求
    サービスプロバイダ事業者->>プラットフォーム事業者: 本人確認記録IDの送信
    Note Over プラットフォーム事業者:2.本人確認記録データの取得
    プラットフォーム事業者->>プラットフォーム事業者: 該当する本人確認記録の取得
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:3.本人確認記録データの返却
    プラットフォーム事業者->>サービスプロバイダ事業者: 本人確認記録の返却
```
    </Tab>
    <Tab title="検索条件を指定して照会">
```mermaid
    %%{init:{'theme':'natural'}}%%
    sequenceDiagram
    autonumber
    participant 利用者
    participant 本人確認アプリ
    participant サービスプロバイダ事業者
    participant プラットフォーム事業者

    Note Over サービスプロバイダ事業者,プラットフォーム事業者:1.本人確認記録照会の要求
    サービスプロバイダ事業者->>プラットフォーム事業者: 本人確認完了日時の期間・実施形式<br>書類種別などの検索条件を送信
    Note Over プラットフォーム事業者:2.本人確認記録データの取得
    プラットフォーム事業者->>プラットフォーム事業者: 該当する本人確認記録を検索
    Note Over サービスプロバイダ事業者,プラットフォーム事業者:3.本人確認記録データの返却
    プラットフォーム事業者->>サービスプロバイダ事業者: 本人確認記録の一覧を返却
    opt 続きの記録がある場合
        サービスプロバイダ事業者->>プラットフォーム事業者: カーソルを指定して再度リクエスト
        プラットフォーム事業者->>サービスプロバイダ事業者: 続きの本人確認記録を返却
    end
```
    </Tab>
</Tabs>

<br>