デジタル庁が開発事業者向けに提供するサービス・APIに関するドキュメントの一覧です。

ドキュメント

デジタル認証サービスを利用される行政機関等・民間事業者向け実装ガイドラインです。

デジタル認証アプリ

行政機関等・民間事業者向け実装ガイドライン

## 氏名突合支援サービスとは
デジタル庁が提供する氏名の「漢字・アルファベット」と「カナ」を突合・推定する業務を支援するためのAPI等を提供するサービスです。

## 提供コンテンツ
氏名突合支援サービスにて提供するコンテンツは次の通りです。
いずれの利用に際しても「[利用規約](/documents/name-matching-support/terms-of-use/)」及び「[プライバシーポリシー](/documents/name-matching-support/privacy-policy/)」をご確認いただき、規約に同意の上でご利用ください。

| コンテンツ | | 提供場所 |
|-|-|-|
| 氏名漢字カナ突合API | 利用方法 | [氏名突合支援サービスサポートサイト（クイックスタート）](https://kktg.digital.go.jp/support/) |
| | APIキー管理 | [氏名突合支援サービスサポートサイト（APIキー管理ページ）](https://kktg.digital.go.jp/dashboard) |
| | 利用サンプルプログラム・Excelツール | [デジタル庁 GitHub（kanjikana-api-sample）](https://github.com/digital-go-jp/kanjikana-api-sample) [氏名突合支援サービスサポートサイト（デモ）](https://kktg.digital.go.jp/public/webapp/index.html) |
| 氏名漢字カナ突合モデル | 利用方法・詳細仕様 | [氏名突合支援サービスサポートサイト](https://kktg.digital.go.jp/support/) |
| | ソースコード | [デジタル庁 GitHub（kanjikana-model）](https://github.com/digital-go-jp/kanjikana-model) |
| | 辞書データ・AIモデル | [氏名突合支援サービスサポートサイト（リソース）](https://kktg.digital.go.jp/support/) |

## 利用・展開のイメージ
氏名突合支援サービスの中核機能である「氏名漢字カナ突合API」は、お手持ちのメールアドレスでアカウント登録後、すぐに氏名漢字カナ突合API（デジタル庁提供方式）の利用が可能です。

ネットワーク環境の制限などにより、デジタル庁が提供するサービスをインターネット経由で直接利用できなかったり、デジタル庁による制限なく自由に利用したい場合のため「セルフホスティング方式」に必要となるコンテンツの提供もしております。セルフホスティング方式にて必要となるソースコード等は、デジタル庁が管理する「[デジタル庁 GitHub（kanjikana-model）](https://github.com/digital-go-jp/kanjikana-model)」にて配布しています。

各種詳細な仕様については「[氏名突合支援サービスサポートサイト](https://kktg.digital.go.jp/support/)」を参照ください。
![デジタル庁提供方式とセルフホスティング方式の違いに関する図です。氏名突合支援サービスの中核機能である氏名漢字カナ突合APIは、すぐに利用できるデジタル庁提供方式と、デジタル庁が提供するソースコード等を使って、占有環境を整備するセルフホスティング方式のいずれかの方法で利用可能です。セルフホスティング方式については提供サービスに合わせ、独自カスタマイズいただいて利用いただくことができます。
また、APIを容易に使い始められるよう、Excelのツールをデジタル庁から提供していますが、HTTP APIでのアクセスが可能ですので、独自のツール、アプリケーションやシステムからの利用いただくこともできます。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/e4cdcd2d09f74ab186ee6cff0387a24a/kktg_deploy.svg)

### 想定されるユースケース
本サービスを利用する業務のユースケースとしては次のようなものを想定しています。
あくまで想定であり、以下ユースケース以外での利用を妨げるものではありません。
突合作業に際し、「氏」と「名」の両方は必須ではなく、「氏だけ」「名だけ」での利用も可能です。

#### データ内の氏名の整合性確認
人手により入力されたデータ（自由入力可能な電子入力フォームデータや手書き書類をOCR等にて電子化したもの）の氏名・カナの整合性チェックするような業務での利用が想定されます。
![データ内の氏名の整合性確認の概念図です。電子入力フォームや手書き書類内などにある、氏名とカナ、氏名と口座名義のカナの整合性をチェックするような用途で利用できます。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/29a998bd9dd34ababb797349c2fc982b/kktg_usecase_data-check.svg)

#### 源泉が異なるデータ間の氏名とカナでの照合
データ（漢字氏名、カナ氏名をそれぞれ含むデータ）間の名寄せ、自治体での給付業務における漢字氏名と振込先口座名義人（＝カナ氏名）の突合作業などでの利用が想定されます。
![源泉が異なるデータ間の氏名とカナでの照合の概念図です。複数の別データ間で、漢字・アルファベット表記の氏名と仮名表記の氏名とを突合し、データの名寄せに利用できます。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/a91501e755ba40a7a77dddc080d2d2f2/kktg_usecase_data-link.svg)

## 氏名突合支援サービスの仕様
APIのリクエストパラメータやレスポンスの詳細については「[氏名漢字カナ突合API](/documents/name-matching-support/api-spec/)」のページを参照してください。

### 提供するAPI機能
「氏名漢字カナ突合API」では以下4つの機能を提供しています。

| 機能 | | やりたいこと |
|------|--------|--------------|
| 氏名突合 | 簡易突合（simple） | 「漢字・アルファベット氏名」と「カナ氏名」の組合せの正確性を**スピーディ**に確認したい |
| | 詳細突合（detail） | 「漢字・アルファベット氏名」と「カナ氏名」の組合せの正確性を**より多くの情報に基づき**確認したい |
| 氏名推定 | 漢字→カナ推定（kanji） | 「漢字・アルファベット氏名」から「カナ氏名」の候補を取得したい |
| | カナ→漢字推定（kana） | 「カナ氏名」から「漢字・アルファベット氏名」の候補を取得したい |

### APIで入力として許容される氏名の形式

#### 標準形式
「氏名」の場合には、スペース（全角・半角問わず）で区切って入力してください。「氏のみ」や「名のみ」でも入力可能です。
また、「氏名」にアルファベット（全角・半角問わず）を含めることも可能です。
「カナ」はカタカナでの入力を基本としていますが、ひらがなでの入力も可能です。

| 形式 | | 氏名（kanji） | カナ（kana） |
|-|-|-|-|
| **基本形** | **氏名** | 日本　花子 | ニホン　ハナコ |
| | **氏だけ** | 日本 | ニホン |
| | **名だけ** | 花子 | ハナコ |
| **ひらがな** | **氏名** | 日本　花子 | にほん　はなこ |
| | **氏だけ** | 日本 | にほん |
| | **名だけ** | 花子 | はなこ |
| **アルファベット（全角）** | **氏名** | ＮＩＰＰＯＮ　ＨＡＮＡＫＯ | ニッポン　ハナコ |
| | **氏だけ** | ＮＩＰＰＯＮ | ニッポン |
| | **名だけ** | ＨＡＮＡＫＯ | ハナコ |
| **アルファベット（半角）** | **氏名** | NIPPON HANAKO | ニッポン　ハナコ |
| | **氏だけ** | NIPPON | ニッポン |
| | **名だけ** | HANAKO | ハナコ |

#### マイナンバーカード（券面）の氏名形式
マイナンバーカード（券面）の氏名に準拠した形式の文字列を入力として受け付けられるように構成されています。

| 形式 | 氏名（kanji） | カナ（kana） |
|------|------|------|
| **漢字氏名** | 日本　花子 | ニッポン　ハナコ |
| **漢字氏名＋旧氏** | 日本 [東京]　花子 | ニッポン　ハナコ トウキョウ　ハナコ |
| **アルファベット氏名** | ＮＩＰＰＯＮ　ＨＡＮＡＫＯ | ニッポン　ハナコ |
| | ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ | ニッポン　ジャパン　ハナコ |
| | ＨＡＮＡＫＯ　ＪＡＰＡＮ　ＮＩＰＰＯＮ | ニッポン　ジャパン　ハナコ |
| **アルファベット氏名＋漢字氏名** | ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子 | ニッポン　ハナコ ニッポン　ジャパン　ハナコ |
| **アルファベット氏名＋漢字氏名＋通称** | ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子（東京　花子） | ニッポン　ハナコ ニッポン　ジャパン　ハナコ トウキョウ　ハナコ |

### 簡易突合（simple）及び詳細突合（detail）の動作
入力として受け付けた「漢字（kanji）」と「カナ（kana）」に対し、各種マッチング処理を行い、判定結果をスコア（0から99までの値で、高いほど正しい可能性が高いことを示す。）で返却します。

![簡易突合（simple）及び詳細突合（detail）の動作の概念図です。一般的な読みであれば、簡易突合でも判定可能ですが、珍しい読み方をする場合には詳細突合でないと正しく判定できないことがあります。明らかに誤った読みである場合には、簡易突合・詳細突合に関わらず、誤っているであろうという判定を行います。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/588e5bd648cc4151995552bb2f9cc45c/kktg_process-flow_matching.svg)

返却するスコアとその意味は以下の通りです。返却スコアパターンは今後変更される可能性があります。詳細は「[氏名突合支援サービスサポートサイト](https://kktg.digital.go.jp/support/)」を参照ください。
「50」をしきい値として、50以上を正、50未満（49以下）を誤として判定いただくことを推奨しています。

![氏名突合の出力スコアの概要図です。公開時のモデル・APIでは、90・80・70・30・0の5段階で結果出力されます。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/07d5f5498fe840d7a39d1528e216856d/kktg_matching-score.svg)

### 氏名推定（漢字・アルファベット⇔カナ）の動作
入力として受け付けた「漢字・アルファベット」・「カナ」に対応する、正解である可能性が高い「カナ」・「漢字」を返却します。

![氏名推定機能の概要図です。氏名の漢字・アルファベットと氏名のカナを相互推定することができます。デフォルトで上位5候補、パラメータの指定により多くの候補を出力できます。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/1cec3f27241b4f11a7b71ce74520b34b/kktg_process-flow_prediction.svg)

### マッチング手法の概要
氏名漢字カナ突合モデルで用いているマッチング手法としては下記4種類があり、組み合わせてマッチングをしています。

詳細は「[氏名突合支援サービスサポートサイト](https://kktg.digital.go.jp/support/)」にて説明しています。

#### 辞書マッチング
辞書にある読み方がどうかを判断し、一致・不一致を判定しています。

![辞書マッチングの概念図です。入力された氏名を辞書データを比較（マッチング）し、氏名全体が辞書データにある場合、正しいと判定する手法です。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/6124a2aa33d0487a973a5ac004b04afd/kktg_method_dict.svg)

#### 統計マッチング
漢字氏名とカナ氏名のペアの出現頻度（回数）と設定したしきい値に基づき、一致・不一致の判定をしています。

※注：一般公開している氏名漢字カナ突合APIでのマッチング判定においては、統計マッチングによる判定はしていません。

![統計マッチングの概念図です。入力された氏名を統計データを比較（マッチング）し、統計データに基づき、より多くの利用ケースがある氏名である場合、正しいと判定する手法です。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/0b4d5c5c0211427fbb0fa1a2d09b7e11/kktg_method_statistics.svg)

#### 外国人名マッチング
名古屋大学の佐藤理史先生の研究成果であるアルゴリズム・システムを活用し、一致・不一致の判定をしています。

詳細は「[2020東京オリンピック参加者名簿の翻訳（佐藤 理史、自然言語処理 Vol. 30 No. 2）](https://www.jstage.jst.go.jp/article/jnlp/30/2/30_748/_pdf/-char/ja)」を参照ください。

#### AI推論マッチング
学習用辞書からAIエンジンを用いて生成したAIモデルを用いて、一致・不一致の判定しています。

![AI推論マッチングの概念図です。学習用辞書からAIエンジンを用いて生成した、入力された氏名から対応するカナを推定するAIモデルを用い、AIモデルによる出力候補に含まれるカナである場合、正しいと判定する手法です。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/92d3217d19c74ca6be3eefaf11812987/kktg_method_ai.svg)

氏名突合支援サービスの概要について

氏名突合支援サービス（APIキー管理ページ）

デジタル庁 GitHub（API利用サンプル）

デジタル庁 GitHub（氏名漢字カナ突合モデル）

氏名突合支援サービス

概要

氏名突合支援サービスの利用規約について

利用規約

2025（令和7）年10月20日　施行

更新履歴

氏名突合支援サービスプライバシーポリシー（以下「本プライバシーポリシー」といいます。）は、デジタル庁が提供する氏名突合支援サービス（以下「本サービス」といいます。）において取得する個人情報等を含む利用者の情報（以下「利用者情報」といいます。）の取り扱いに関する方針等を定めるものです。

## 1　基本方針
本サービスでは、提供するサービスの円滑な運営に必要な範囲で、本サービスの利用者情報を取得します。取得した情報は、利用目的の範囲内で適切に取り扱います。

## 2　適用範囲
本プライバシーポリシーは、本サービスにおいてのみ適用されます。本サービス外（外部リンク先のウェブサイト等）での個人情報の取り扱いについては、各管理組織が定めるポリシーに準じます。

## 3　取得する利用者情報の範囲及び利用目的
1. 本サービスでは次に掲げる利用者情報を収集し、目的の範囲内で利用します。
 【取得する利用者の情報】
 　(1) 電子メールアドレス
 　(2) 本サービスへのアクセスログ（アクセス日時、参照元のサイトドメイン名、IPアドレス、システム環境（OSやウェブブラウザ等）に係るログ等）
 【目的】
 　(1) 本サービスの提供
 　(2) 本サービスに関する案内の通知
 　(3) 本サービスの利用状況確認
 　(4) 本サービスの改善
 　(5) 障害や不正アクセス等の調査
1. 利用者の退会後も、取得する利用者の情報 (2) は目的 (3)(4)(5) のため、デジタル庁が定める方針に従い保持されます。

## 4　取得しない情報
本サービスでは、[3　取得する利用者情報の範囲及び利用目的](#3取得する利用者情報の範囲及び利用目的) に掲げる個人情報等を除き、氏名、生年月日、その他一般的に個人を識別できる情報を取得しません。
氏名突合支援APIの利用に必要なデータに含まれうる氏と名については、サービス提供に必要となる情報処理のみに利用し、取得は行いません。

## 5　利用者情報の利用及び第三者提供の制限
法令に基づく開示要請があった場合、不正アクセスや脅迫等の違法行為があった場合、その他特別の理由のある場合を除き、取得した利用者情報を目的以外のために自ら利用、又は第三者に提供しません。
個人情報等の取扱いにあたっては、[個人情報の保護に関する法律](https://laws.e-gov.go.jp/law/415AC0000000057)（平成15年法律第57号）等、適用ある法令等を遵守し、利用目的の範囲内でこれを行います。
また、本サービスが保有する個人情報等の全部又は一部の処理等を第三者に委託する場合には、個人情報等の適切な管理を行う能力を有する委託先の選定を行うとともに、デジタル庁の定める方針に従った適正な情報管理を行うよう、必要なかつ適切な監督を行います。

## 6　取得した利用者情報の管理
　取得した利用者情報を適切に管理し、漏えいや滅失又はき損のないよう、必要な安全管理措置を講じます。

## 7　プライバシーポリシーの変更
1. デジタル庁は、次の各号のいずれかに該当する場合、本プライバシーポリシーを変更することができるものとします。
    1. 本プライバシーポリシーの変更が、利用者の一般の利益に適合するとき
    1. 本プライバシーポリシーの変更が、登録をした目的に反せず、かつ、変更の必要性、変更後の内容の相当性、変更の内容その他の変更にかかる事情に照らして合理的なものであるとき
1. デジタル庁は、前項の変更を行う場合は、1か月の予告期間をおいて、変更後のプライバシーポリシーの内容を利用者に通知するものとします。
1. 法令上、利用者の同意が必要となるような内容の変更の場合は、デジタル庁所定の方法で利用者の同意を得るものとします。

## 8　通信経路のセキュリティ
利用者がインターネットを介し、本サービスに個人情報等を送信する際のセキュリティ確保のため、通信経路の暗号化（SSL/TLS）により保護します。適切な通信経路保護のため、独立行政法人情報処理推進機構（IPA）が発行している「TLS暗号設定ガイドライン」等に基づき、デジタル庁の判断により、安全性と相互接続性を踏まえたプロトコル及びバージョンを採用します。高いセキュリティリスクを有するプロトコル及びバージョンのみに対応しているウェブブラウザ等によりアクセスした場合、通信経路の安全性が確保できない可能性があることから本サービスを利用できないことがあります。

## 9　クッキーの使用
クッキーとは、ウェブサイトを訪問した際に利用したパーソナルコンピュータやスマートフォンや等のウェブブラウザやそれに相当するソフトウェアにより生成及び記録されるファイルを指し、ウェブサイトの訪問に関連する情報が蓄積されます。当ウェブサイトでは、下記の目的に限りクッキーを使用します。利用者はウェブブラウザやそれに相当するソフトウェアの設定によりクッキーを利用しない設定にすることができます。
【目的】
　(1)　認証情報の記憶

## 10　利用者情報の取り扱いに関する問合せ先
本サービスおよび利用者情報の取扱いに関するお問合せ先は本サービスの利用者情報の取扱いに関する問合せ窓口より受付しております。（本サービスの利用方法等、利用者情報の取扱いに関する事項以外については受付しておりません。）

【問合せ窓口】
　kktg-complaints-desk_atmark_digital.go.jp
　（「\_atmark\_」を半角のアットマークに置き換えてください）

なお保有個人情報の開示等請求の方法については、デジタル庁の[ウェブサイト](https://www.digital.go.jp/personal-information-protection)においてご案内しています。


氏名突合支援サービスのプライバシーポリシーについて

プライバシーポリシー

氏名突合支援サービスのAPI仕様について

API仕様（OpenAPI Specification）

## サービスの仕様

| 質問 | 回答 |
|------|------|
| 「氏名突合支援サービス」とは何でしょうか。 | 「漢字・アルファベット氏名」と「カナ氏名」を突合したり、相互推定するなど、氏名を用いた情報の突合を行う業務を支援するためのサービスです。 |
| 「氏名突合支援サービス」は誰でも使えるのでしょうか。 | どなたでも利用可能です。 広く一般に利用いただくため、他の利用者への迷惑をかけるような使い方をしている利用者に対しては利用制限を行う可能性があります。 |
| 「氏名突合支援サービス」を利用するのに費用が掛かるのでしょうか。 | 無償で利用できます。 デジタル庁が提供するAPIを利用する場合にはメールアドレスを使った登録が必要となります。 |
| サービスの稼働時間を知りたいです。 | 原則24時間365日稼働しています。メンテナンス等、デジタル庁の判断で事前の案内なく変更する場合があります。 |
| 日本国外から利用できますか。 | 提供サービスの特性（氏名の漢字・アルファベット表記とその振り仮名・読み仮名を取り扱う）上、日本国内での利用を前提としています。 また、一部機能については日本国外のIPアドレスからのアクセスをブロックしています。 |
| 氏名突合の精度はどの程度でしょうか。 | 初期公開時点（2025年10月時点）のモデルにおいては、日本人名で95%以上、外国人名で80%以上の精度（正しいものを正しい、誤っているものを誤っていると判定する確率）と評価しております。市販の姓名辞典を用いた突合と比較し、高い精度での判定が可能と考えております。 |
| APIの氏名突合（簡易・詳細）にてスコアが返却されますが、どのように判定に生かせばよいのでしょうか。 | 0～99の範囲でスコアが返却され、50以上を正、50未満（49以下）を誤（閾値を50）として判断することで大半のユースケースにおいて有効な判断が行えると考えておりますが、業務特性等を背景としてより高い精度に基づく判定を行いたい場合には閾値を高く設定いただくことで、より業務にあった突合判定も可能です。 |
| 出力された名に常用漢字や人名用漢字ではないものが含まれることはありますか。 | 本サービスでは常用漢字や人名用漢字のみ出力するような制限は行っていませんので、常用漢字や人名用漢字に含まれない文字が返却される可能性はあります。 |
| 正解データは公開されないのでしょうか。 | 正解データそのものの公開は想定しておりません。 |


## サービスのメンテナンス

| 質問 | 回答 |
|------|------|
| メンテナンス情報はどこに掲載されますか。 | 原則、デジタル庁 開発者サイトの「[新着・更新](/news/)」にて案内します。 場合により、事前連絡なく停止することがあります。 利用制限やメンテナンス時間等を気にされる場合には、セルフホスティングでの利用をご検討ください。 |
| 公開されているコンテンツ（APIやモデル等）はどの程度で更新されるのでしょうか。更新された場合、どのような案内がされるでしょうか。 | 精度の向上の見込みなどが立ったタイミング、セキュリティ上のリスクなどが明らかになった等を起因として、不定期での更新を行います。 更新が生じた場合、開発者サイト「[新着・更新](/news/)」にて原則案内をしますが、軽微な更新の場合（仕様変更が生じないなど、既存利用者への影響が見込まれない場合）には、案内なく更新を行います。 |


## 権利・情報の取扱い

| 質問 | 回答 |
|------|------|
| 提供されているソースコードや辞書データは自由に使ってよいのでしょうか。 | 利用規約及びソースコードや関連ドキュメントに記載されているライセンスに従い、取り扱いをお願いします。 ソースコードは原則「[MIT License](https://opensource.org/license/mit)」にて公開しており、比較的自由に利用いただけるライセンス形態となっています。 |
| 氏名突合支援サービスにて出力されるデータの信頼性はデジタル庁が担保してくれるのでしょうか。 | 氏名突合支援サービスにて提供するすべての情報について、その信頼性・正確性についてデジタル庁は責任を負いません。 出力された情報は利用者自身の責任で妥当性等を確認いただくようにお願いします。 |
| 氏名突合支援サービスで提供されているコンテンツ（ソースコード等）がデジタル庁管理外のサイトで公開されています。利用して問題ないでしょうか。 | デジタル庁が氏名突合支援サービスに関連して公開しているコンテンツは、デジタル庁ドメイン（digital.go.jp）またはそのサブドメインかデジタル庁管理の GitHub Organization（[digital-go-jp](https://github.com/digital-go-jp)）配下でのみ公開しています。 それ以外のサイトにて公開されているコンテンツについては、デジタル庁の関与はありません。 原則デジタル庁が公開するコンテンツをご利用ください。 |
| 氏名突合支援サービスの個人情報等の取扱いについて知りたい。 | 「[プライバシーポリシー](/documents/name-matching-support/privacy-policy/)」をご参照ください。 |
| 氏名突合支援サービスが取得する利用者情報について知りたい。 | 「[プライバシーポリシー](/documents/name-matching-support/privacy-policy/)」をご参照ください。 |


## アカウント・API

| 質問 | 回答 |
|------|------|
| サポートサイト（APIキー管理ページ）のアカウントを作成、APIキーを取得し、APIを利用したいです。 | 「氏名突合支援サービスサポートサイト（APIキー管理ページ）」の下部にある「利用者新規登録」より案内に従って登録を行ってください。 登録が完了すると、APIキーを取得できます。 取得したAPIキーを利用して、APIをご利用ください。 |
| サポートサイト（APIキー管理ページ）のアカウントのパスワードを忘れました。パスワードの初期化をしたいです。 | 「氏名突合支援サービスサポートサイト（APIキー管理ページ）」にある「パスワードを忘れた場合」より案内に従ってパスワードの再設定（回復）を行ってください。 パスワードの再設定には、アカウント登録に使用したメールアドレスにてメールを受信できる必要があります。 |
| デジタル庁が提供するAPIを利用するために必要な通信先を教えてください。 | デジタル庁が提供するAPIにおいては、以下に示す通信の許可が必要です。 セルフホストする場合にはこの限りではありません。 アドレス：api.kktg.digital.go.jp プロトコル・ポート：HTTPS（TCP/443） |
| 「APIキー」とは何でしょうか。どのように管理できますか。 | 本サービスにおけるAPI（Application Programming Interface）キーとは、「氏名漢字カナ突合API」として提供するRESTful API（氏名突合及び氏名推定）において、利用者の認証・認可を行うための鍵となります。 具体的な形式としては、半角英字（大文字・小文字）・半角アラビア数字からなる32文字の文字列です。 APIキーは利用者（サービス登録者）と紐づいておりますので、赤の他人への提供をしないよう、APIキーを取得した方の責任にて管理してください。 利用者に紐づくAPIキーは「氏名突合支援サービスサポートサイト（APIキー管理ページ）」にて管理（確認、作成、削除等）が可能です。 | 
| 「APIキー」の利用状況（API利用回数・最終利用日時等）を確認することはできますか。 | そのような機能は提供しておりません。 |
| 「APIキー」を削除してしまいました。復元できますか。 | 一度削除したAPIキーは復元できません。 新たにAPIキーを作成し、新しいAPIキーを利用してください。 |
| サポートサイト（APIキー管理ページ）のアカウントを削除してしまいました。復元できますか。 | 一度削除したアカウントは復元できません。再度アカウント登録を行ってください。 また、アカウントに紐づいたAPIキーも復元できませんので、新しいアカウントに紐づいたAPIキーを利用してください。 |
| 氏名漢字カナ突合APIに入力した情報（氏・名）は保存されるのでしょうか。 | 「[プライバシーポリシー](/documents/name-matching-support/privacy-policy/)」に示す通り、APIへ入力された情報は保存されません。 懸念がある場合には、セルフホスティング方式をご活用ください。 |


## その他

| 質問 | 回答 |
|------|------|
| 氏名突合支援サービスの技術的な内容について質問したい。 | 大変申し訳ございませんが、問合せ窓口は設けておりません。 本開発者サイトや[サポートサイト](https://kktg.digital.go.jp/support/)をご参照ください。 自治体職員の方向けには「デジタルPMO」等の行政機関間コミュニケーションプラットフォームを通じた質問受付を行う予定です。 |
| [マイナンバー情報総点検](https://www.digital.go.jp/councils/mynumber-all-check)において使用された「点検支援ツール」との違いは何でしょうか。 |目的・機能が大きく異なります。 「氏名突合支援サービス」の方が幅広く、様々な業務にてご利用いただけるものとなっております。 ●点検支援ツール 対象者：自治体職員 目的：業務システムでの他人への紐づけ誤りがないかを確認（総点検）するため、表記揺れを正規化の上、機械的に照合し、人手での照合作業を省力化 機能：業務システムと住基ネットのデータを読み込み、「マイナンバー＋基本4情報」を照合、一致した項目により「確認不要」「要確認」「優先確認」を返す ●氏名突合支援サービス 対象者：氏名の突合を行いたい方（個人・法人問わず） 目的：氏名とそのカナの一致確認を機械的に行い、人手でのデータ紐づけ作業や入力データ確認等の省力化 機能：氏名の漢字・アルファベット・カナを入力として、以下機能を提供。 入力された氏名（漢字・アルファベットとカナ）の対応可能性を推定 氏名（漢字・アルファベット）⇔カナの相互推定 |
| 氏名突合支援サービス（API及び関連ツール）を業務に活用することにより、どの程度の削減効果を見込むことができますか。 | 担当者のスキル（慣れ等）にも依存しますが、氏名の漢字とカナの突合を目視検査によりチェックを行う場合、1時間あたり1000件程度（日本人名・外国人名混在）処理できると考えております。 APIによる事前処理にて、目視での確認が必要な対象者を絞ることにより、検査時間を半分から10分の1程度に削減することができると考えております。 |

氏名突合支援サービスに関するよくある質問とその回答

よくある質問

Jグランツ

APIドキュメント

民間事業者向けのAPIリファレンスです。

APIリファレンス（民間事業者向け）

行政機関向けのAPIリファレンスです。

APIリファレンス（行政機関向け）

# テストカード代替機能
デジタル認証アプリおよびテスト用のマイナンバーカードを使用することなくサービスに組み込んだ認証および署名機能をテストすることができる機能です。 
テスト用マイナンバーカードを持っていないサービス事業者もデジタル認証アプリの接続が簡単にできるようにする機能です。いくつかあるテストデータの中からデータを選択し、データに従ったAPIレスポンスを返却します。テストカード代替機能を使用する場合とテスト用デジタル認証アプリ（テスト用マイナンバーカード）を使ったテストとを両立することはできません。
認証APIをご利用のサービス事業者のみに提供します。

## 事前準備

以下の開発者サイトのドキュメントをご参照の上、RPとテスト環境への連携を行ってください。

https://developers.digital.go.jp/documents/auth-and-sign/implement-guideline/

RPからデジタル認証アプリサーバへ認可リクエストを実行してください。サービスのウェブページからリダイレクトされ、以下のデジタル認証アプリ 認証API/署名APIテストレスポンス設定画面が表示されます。

下記にデジタル認証アプリ 認証API/署名APIテストレスポンス設定画面の操作方法を示します。

## 認証テストレスポンス設定画面操作方法

### 正常レスポンスを返却する場合

1. レスポンスから[正常]ラジオボタンを選択します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/097abfff10524a639d73f821687a6d6a/01_auth_test_normal_op.png)
 
 
2. テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/2be02183ee5d4edfb085842fcbd1ba48/02_auth_test_normal_op.png)
 
 
3. RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト（認可コードフロー）などの後続処理を行うことができます。

### 異常レスポンスを返却する場合

1. レスポンスから[異常]ラジオボタンを選択します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/b8e428838c10449aa21bf6cfda45be11/03_auth_test_error_op.png)
 
 
2. 「エラーパターン」の中からテストを実施したいエラーパターンを選択します。
 
 ※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/3904aacecc2949008ee936e2f417c7e1/04_auth_test_error_op.png)
 
 
3. テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/e9fbe6e12ea94d85a8ce575aba6e4887/05_auth_test_error_op.png)
 
 
4. 選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。
 - RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。
 
 - レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/5b84fe7b43fd4905a5d65b9b8fe4aa03/06_auth_test_error_op.png)
 
 
 - 選択したエラーパターンがHTTP 503エラーを発生する合は、以下のエラーページが表示されます。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/124bd0efa56e4306860917a158c2e86c/07_auth_test_error_pg.png)
 
 
　　- 選択したエラーパターンがHTTP 504エラーを発生する合は、以下のエラーページが表示されます。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/4f4c1f0d5cd64b728cfd56a0adac002d/08_auth_test_error_pg.png)
 

## 署名テストレスポンス設定画面操作方法

### 正常レスポンスを返却する場合

1. レスポンスから[正常]ラジオボタンを選択します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/3a1c3a42e2bf4f4daf1011a98fb8f50a/09_sign_test_normal_op.png)
 
 
2. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/fcd5b2f56c4042919f1135a22817ad6b/10_sign_test_normal_op.png)
 
 
3. RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト（認可コードフロー）などの後続処理を行うことができます。
 
 

### 異常レスポンスを返却する場合

#### エラーパターンのエラーをテストしたい場合

入力項目「エラーパターン」の中からテストを実施したいエラーパターンを選択します。
このエラーパターンは、一般的な異常状況をテストするために使用されます。

1. レスポンスから[異常]ラジオボタンを選択します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/a940e56a167d453386a46be2d92bd64d/11_sign_test_error_op.png)
 
 
2. エラーパターンの中からテストを実施したいエラーパターンを選択します。
 
 ※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/d103943bc9434ef18519ba256ad92b7d/12_sign_test_error_op.png)
 
 
3. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/9bd2b27a3cea4f56b37beec24948b42c/13_sign_test_error_op.png)
 
 
4. 選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。
 - RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。
 
 - レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。

 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/70fad3c4f6be4297a19f9ef7b6bfb2c5/14_sign_test_error_op.png)


- エラーパターンを選択した結果HTTP 503エラーの場合は以下のエラーページが表示されます。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/d9f6e44c5cd040ad8a45d8a6ba98e400/15_sign_test_error_pg.png)
 
 
- エラーパターンを選択した結果HTTP 504エラーの場合は以下のエラーページが表示されます。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/0d1964ea504f4699b920892257a83e42/16_sign_test_error_pg.png)
 

#### 署名トランザクション結果取得エラーパターンのエラーをテストしたい場合

入力項目「エラーパターン」は[-]（未選択）を選択し、

入力項目「署名トランザクション結果取得エラーパターン」の中からエラーパターンを選択してください。
このエラーパターンは、特定の異常状況を検証するために使用されます。

1. [異常]ラジオボタンを選択します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/3d164cd89d5d4c3ca416cdc68f2d293c/17_sign_result_test_error_op.png)
 
 
2. 署名トランザクション結果取得エラーパターンを選択します。
 
 ※署名トランザクション結果取得エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/9527b78a1dc448c88868a928026894f6/18_sign_result_test_error_op.png)

 
3. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
 
 ![](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/6295c1657ba7444497b634952da2a84e/19_sign_result_test_error_op.png)
 
 
4. RPへ署名トランザクション結果取得レスポンスが返却されますのでエラーの内容を確認してください。
 
### バックチャネルログアウトを実行する場合
 テストカード代替機能において、デジタル認証アプリサーバからRPのサーバへback-channel logoutリクエストを発生させるためには、以下の手順を行なってください。

1. テストカード代替機能の"正常レスポンスを返却する場合”の操作を行い、サーバにおいてクライアントアサーションの取得とリフレッシュトークン、IDトークン、IDトークンに含まれsub値のいずれかを取得してください

1. 下記の通りHTTP POSTリクエストを送信します。
 - リフレッシュトークンを使用する場合 
 URL：\https\://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout 
 Content-Type：application/x-www-form-urlencoded 
 リクエストボディ：
 - client_assertion_type：urn:ietf:params:oauth:client-assertion-type:jwt-bearer
 - client_assertion：クライアントアサーション（クライアント認証のための情報を含むJWT）
 - refresh_token：アクセストークン発行レスポンスに含まれるリフレッシュトークン
 - IDトークンを使用する場合 
 URL：\https\://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout 
 Content-Type：application/x-www-form-urlencoded 
 リクエストボディ：
 - client_assertion_type：urn:ietf:params:oauth:client-assertion-type:jwt-bearer
 - client_assertion：クライアントアサーション（クライアント認証のための情報を含むJWT）
 - id_token：アクセストークン発行レスポンスに含まれるIDトークン
 - Sub値を使用する場合 
 URL：\https\://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout 
 Content-Type：application/x-www-form-urlencoded 
 リクエストボディ：
 - client_assertion_type：urn:ietf:params:oauth:client-assertion-type:jwt-bearer
 - client_assertion：クライアントアサーション（クライアント認証のための情報を含むJWT）
 - subject_id：アクセストークン発行レスポンスのIDトークンに含まれるsub値

1. バックチャネルログアウトが成功した場合、下記の通りレスポンスが返却されます。 
 HTTPステータス：200 
 Content-Type: application/json 
 レスポンスボディ：
 - executed_backchannel_logout：true 

## エラーパターンの詳細

エラーパターンに関しては以下をご参照ください。

| 入力項目 | 選択値 | 概要 | 認証/署名ボタン押下後動作 |
| --- | --- | --- | --- |
| エラーパターン | invalid_request | ・Missing parameter: ○○○○ リクエストに必須パラメータのキーが存在しない。 ※「○○○○」には必須パラメータ名が設定される。 ・Invalid parameter: ○○○○ リクエストの必須パラメータに値が設定されていない。 リクエストのパラメータに未知の値が設定されている。 ※「○○○○」には必須パラメータ名が設定される。 ・Invalid initialRegistSessionId for authentication 初期登録セッションIDが設定されてない。 ・Check initialRegistSessionId by backend failed 初期登録セッションIDが不正。 ・Invalid initialRegistSessionId for authentication 初期登録セッションIDが不正。 ・No refresh token リクエストに必須パラメータ（refresh_token）が存在しない。 | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | unsupported_response_type | デジタル認証アプリサーバーは設定された方法による認可コード取得をサポートしていない。 ・リクエストの必須パラメータ（response_type）に値が設定されていない。 ・リクエストのパラメータ（response_type）に未知の値が設定されている | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | unauthorized_client | ・Client is not allowed to initiate browser login with given response_type. Implicit flow is disabled for the client. リクエストパラメータの指定誤り。（response_typeに"token"が設定されている） ・Client not allowed for direct access grants リクエストパラメータの指定誤り。（grant_typeに"password"が設定されている） ・Invalid client credentials 該当クライアントがシステム側で停止されている。 ・Invalid client secret リクエストの必須パラメータ（client_secret）に値が設定されていない。 リクエストの必須パラメータ（client_secret）に未知の値が設定されている。 | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | invalid_scope | ・Invalid scopes: ○○○○ リクエストの scope に値が設定されていない。 リクエストの scopeに未知の値が設定されている。 ※「○○○○」にはscopeの値が設定される。 | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | access_denied | ・Internal error happened その他の例外エラーが発生した場合。 | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | access_denied(Authentication failed) | ・Authentication failed マイナンバーカード読み取りエラーが発生した場合。 | HTTP 302によってエラーレスポンスをRPへ返却 |
| エラーパターン | server_error | ・Invalid admin consol parameter デジタル認証アプリサーバ管理コンソール設定のバックエンドサーバURL設定がされていない。 デジタル認証アプリサーバ管理コンソール設定のキャッシュ時間が設定されていない。 デジタル認証アプリサーバ管理コンソール設定のキャッシュ時間が数値でない。 ・Internal server error 通信エラー。 | HTTP500でエラーレスポンスを返却 |
| エラーパターン | service_temporarily_unavailable | デジタル認証サービスシステムメンテナンス中の場合。 | HTTP 503 エラーページを表示 |
| エラーパターン | jpki_temporarily_unavailable | 公的個人認証サービスメンテナンス中の場合。 | HTTP 503 エラーページを表示 |
| エラーパターン | forbidden | アクセス拒否・アクセス権限がない場合 | HTTP 504 エラーページを表示 |
| エラーパターン | payload_too_large | リクエストの本文が長すぎてサーバが処理できない場合 | HTTP 504 エラーページを表示 |
| エラーパターン | too_many_requests | クライアントが短期間に過剰なリクエストを送信したため、サーバーがそれ以上のリクエストを処理できない場合 | HTTP 504 エラーページを表示 |
| エラーパターン | bad_gateway | RPのサーバー側で起きた問題によって、一時的に正しくデータの送受信ができない場合 | HTTP 504 エラーページを表示 |
| エラーパターン | gateway_timeout | RPのサーバーがリクエストを処理中にタイムアウトが発生した場合 | HTTP 504 エラーページを表示 |
| エラーパターン | request_blocked | WAF(Web Application Firewall)が攻撃検知した場合 | HTTP 504 エラーページを表示 |
| 署名トランザクション結果取得エラーパターン | invalid_request-status | 署名トランザクションIDの状態が不正な状態の場合 | 署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却 |
| 署名トランザクション結果取得エラーパターン | expired_sign_transaction | 署名トランザクションが有効期限切れの場合 | 署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却 |
| 署名トランザクション結果取得エラーパターン | invalid_request-no_data | 署名トランザクションIDと一致するデータが存在しない場合 | 署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却 |
| 署名トランザクション結果取得エラーパターン | locked_certificate | 署名用電子証明書がロックされている場合 | 署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却 |
| 署名トランザクション結果取得エラーパターン | not_installed_certificate | 署名用電子証明書が搭載されていない場合 | 署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却 |


## 変更履歴

- 2025-03-27
 - 初版公開

デジタル認証アプリおよびテスト用のマイナンバーカードを使用することなくサービスに組み込んだ認証および署名機能をテストするができる機能です。

テストカード代替機能

## はじめに

デジタル認証アプリを利用する直前の画面には、以下のいずれかの方法でアプリを利用することを必ず表示します。

- アプリ名とアプリアイコンを表示
- アプリ名とアクションボタンを表示

## 画面上の表示方法

利用者が、デジタル認証アプリを使って認証・署名することがはっきりとわかるように、提供するサービスの画面にデジタル認証アプリについての案内を表示します。デジタル認証アプリを用いた認証・署名を提供する場合はこのガイドラインに従ってください。

※ このページにおける単位表記『px』は、すべてCSSピクセルを指します。

![全体で3つの画像がある。左上にスマートフォンでの「アプリ名とアプリアイコンの表示例」、右上にスマートフォンでの「アプリ名とアクションボタンの表示例」、中央下にPCでの「アプリ名とアクションボタンの表示例」が掲載されている。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/d90337c988e243d1ae16eaa8f91690cc/auth-and-sign-design-guide-01.png)

## アプリ名の表示
### アプリ名

アプリ名は、略さず必ず正しい名称を使用してください。

### 正しい名称

◯「デジタル認証アプリ」

### 誤った名称
×「認証アプリ」
×「マイナ認証アプリ」

## アプリアイコンの表示

### アプリアイコンの素材

ダウンロード：

:download-button{url="https://files.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/a69b009e2cbb40ffa52db13564dd15eb/Digital-Identification_App-Icon.zip" filename="Digital-Identification_App-Icon.zip" size="8700"}

zipファイルからはPNGファイルとSVGファイルの一式が展開されます。

## アクションボタンの表示

### アクションボタンの定義

アクションボタンのボタン内要素は下記の2つのパーツで構成されています。

- デジタル認証アプリのアイコン
- ボタンラベル

![アクションボタンのボタン内要素を示したイメージ。「デジタル認証アプリのアイコン」と「ボタンラベル」の2つのパーツで構成されている。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/cfa63ebbe5fb4b358f64bf429b2fbc0f/auth-and-sign-design-guide-02.png)

### アクションボタンを画像素材で実装する場合

#### アクションボタンの素材

ダウンロード：

:download-button{url="https://files.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/d38e7101f04a46bea5cbaa5803e062ab/Digital-Identification_Action-Button.zip" filename="Digital-Identification_Action-Button.zip" size="281300"}

zipファイルからはPNGファイルの一式が展開されます。

提供されている素材は以下のスタイルを含みます。

- 種類：ラベルテキストを含むアクションボタン画像
- モード： ライトとダーク
- 形状： 塗りとアウトライン
- 状態： デフォルト、ホバー、アクティブ

#### サイズ

ボタンの高さは必ず48px以上で使用してください。

### アクションボタンを独自に実装する場合

#### カラースキーム

以下のカラースキームを用意しています。提供するサービスのスタイルに合うように選んでご使用ください。隣接色に対するコントラスト比を確保するために画面の背景色に応じて青の濃さを変えてください（ボタンのフチは3:1以上、ボタンラベルは4.5:1以上）。ボタンのフォーカスインジケーターなど、アクセシビリティの詳細はデジタル庁デザインシステムをご確認ください。

![アクションボタンを独自に実装する場合のカラースキームが例示されている。上段が塗りの場合の例。下段がアウトラインの場合の例。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/d076f0b1120945f290130dd557ac4590/auth-and-sign-design-guide-03.png)

| モード | 塗り | 状態 | ボタン | 色 |
| --- | --- | --- | --- | --- |
| ライト | 塗り | Default | ![ライトモード、塗り、状態Defaultのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/9a90efbc842346468607eef38d0e799d/auth-and-sign-design-guide-button-01.png) | 背景色：#0017C1 文字/アプリアイコン色：#FFFFFF |
| ライト | 塗り | Hover | ![ライトモード、塗り、状態Hoverのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/3fdbeff0672d4f9da52f113725a8042d/auth-and-sign-design-guide-button-02.png) | 背景色：#00118F 文字/アプリアイコン色：#FFFFFF |
| ライト | 塗り | Active | ![ライトモード、塗り、状態Activeのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/0cfa5517730e4407bc18174220e515c5/auth-and-sign-design-guide-button-03.png) | 背景色：#000071 文字/アプリアイコン色：#FFFFFF |
| ライト | アウトライン | Default | ![ライトモード、アウトライン、状態Defaultのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/855988eb3028482f88df803074abf74d/auth-and-sign-design-guide-button-04.png) | 背景色：#FFFFFF 文字/アプリアイコン色：#0017C1 線色：#0017C1 |
| ライト | アウトライン | Hover | ![ライトモード、アウトライン、状態Hoverのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/7c9c479d1d624f38b93d1325c0633e68/auth-and-sign-design-guide-button-05.png) | 背景色：#C5D7FB 文字/アプリアイコン色：#00118F 線色：#00118F |
| ライト | アウトライン | Active | ![ライトモード、アウトライン、状態Activeのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/c45dc55d0ece46ec976039a4fcabdbe1/auth-and-sign-design-guide-button-06.png) | 背景色：#9DB7F9 文字/アプリアイコン色：#000071 線色：#000071 |
| ダーク | 塗り | Default | ![ダークモード、塗り、状態Defaultのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/a987eeb6daf54018beb7fcc933b375eb/auth-and-sign-design-guide-button-07.png) | 背景色：#0017C1 文字/アプリアイコン色：#FFFFFF 線色：#264AF4 |
| ダーク | 塗り | Hover | ![ダークモード、塗り、状態Hoverのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/96f19352bcad4bb7a803437057a1e75d/auth-and-sign-design-guide-button-08.png) | 背景色：#00118F 文字/アプリアイコン色：#FFFFFF 線色：#264AF4 |
| ダーク | 塗り | Active | ![ダークモード、塗り、状態Activeのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/36a8ba682ea34e32a5593ebb83069b00/auth-and-sign-design-guide-button-09.png) | 背景色：#0017C1 文字/アプリアイコン色：#FFFFFF 線色：#264AF4 |
| ダーク | アウトライン | Default | ![ダークモード、アウトライン、状態Defaultのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/39743a6200fd4a5d95cbcfe49d74229b/auth-and-sign-design-guide-button-10.png) | 背景色：#000000(70%) 文字/アプリアイコン色：#7096F8 線色：#7096F8 |
| ダーク | アウトライン | Hover | ![ダークモード、アウトライン、状態Hoverのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/caaf71acc92843f0880c73a28fad676f/auth-and-sign-design-guide-button-11.png) | 背景色：#000000(40%) 文字/アプリアイコン色：#C5D7FB 線色：#7096F8 |
| ダーク | アウトライン | Active | ![ダークモード、アウトライン、状態Activeのボタン画像](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/40f15d805ace472fbac0863599b28def/auth-and-sign-design-guide-button-12.png) | 背景色：#000000(60%) 文字/アプリアイコン色：#9DB7F9 線色：#7096F8 |

#### アプリアイコン

アプリアイコンの素材

ダウンロード：

:download-button{url="https://files.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/a69b009e2cbb40ffa52db13564dd15eb/Digital-Identification_App-Icon.zip" filename="Digital-Identification_App-Icon.zip" size="8900"}

zipファイルからはPNGファイルとSVGファイルの一式が展開されます。

#### ボタンラベル

フォントサイズ

- フォントサイズは16px以上にしてください。

フォント

- ボタンラベルのフォントはSans-serifを使用してください。推奨フォントはNoto Sans JPまたはNoto Sansです。

行高

- ボタンラベルの行高はフォントサイズの1.3倍にしてください。

ボタンラベルのテキスト

- ボタンラベルのテキストは、下記のパターンのいずれかを、表示言語に合わせて使用してください。

| 日本語 | 英語 |
| --- | --- |
| マイナンバーカードで本人確認 | Verify identity with My Number Card |
| マイナンバーカードでログイン | Log in with My Number Card |
| マイナンバーカードで認証 | Authenticate with My Number Card |
| マイナンバーカードで署名 | Add a digital signature with My Number Card |
| マイナンバーカードで申請 | Apply with My Number Card |
| マイナンバーカードで口座開設 | Open account with My Number Card |

![ボタンラベルに関するアクションボタンの組み合わせ使用例が示されている。左側に日本語で1行で「マイナンバーカードで本人確認」と記載されたボタン、右側に英語で2行で「Identify yourself with My Number Card」と記載されたボタンが掲載されている。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/63e3bbeb85b4440e96fb3ba09c4c9825/auth-and-sign-design-guide-04.png)

行揃え

- ボタンラベルは左揃えにしてください。
- ボタンの横幅を確保できない場合はボタンラベルを改行できます。改行位置は日本語の場合は「マイナンバーカードで」の後ろ、英語の場合は「with」の前となります。

![アクションボタンでボタンラベルの行揃えをした例が示されている。左側に日本語で2行で「マイナンバーカードで本人確認」と記載されたボタン、右側に英語で2行で「Identify yourself with My Number Card」と記載されたボタンが掲載されている。改行位置は日本語の場合は「マイナンバーカードで」の後ろ、英語の場合は「with」の前。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/73645ba022514f199ff890680c1f404d/auth-and-sign-design-guide-05.png)

#### 余白

ボタン内要素はボタンの中央に配置してください。

左右の余白はボタンラベルのフォントサイズ以上の領域を確保してください。

上下の余白はボタンラベルのフォントサイズの0.75倍以上の領域を確保してください。

アプリアイコンはボタンラベルのフォントサイズの1.5倍以上の領域を確保してください。

アプリアイコンとボタンテキストとの間隔はボタンラベルのフォントサイズの0.75倍以上の領域を確保してください。

余白の基準としてボタンラベルのフォントサイズをAとします。

![アクションボタンのボタン内要素の余白を示した画像。上段は1行で「マイナンバーカードで本人確認」と入れた場合の余白、下段には2行で「マイナンバーカードで本人確認」と入れた場合の余白が示されている。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/b3a8d7fb0fb345228da8c5bdf6823ee2/auth-and-sign-design-guide-06.png)

#### 角丸の半径

サービスのスタイルに合わせて角丸の半径を調整してください。

#### アイソレーションエリア

ボタンの周囲には、上下左右それぞれボタンラベルのフォントサイズの0.5倍以上のアイソレーションエリアを確保してください。
アイソレーションエリアの基準としボタンラベルのフォントサイズをAとします。

![アクションボタンのアイソレーションエリアを示した画像。上段は1行で「マイナンバーカードで本人確認」と入れた場合のアイソレーションエリア、下段には2行で「マイナンバーカードで本人確認」と入れた場合のアイソレーションエリアが示されている。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/27498be82d4d40d893a58aabf6d75358/auth-and-sign-design-guide-07.png)

アイソレーションエリア内に背景画像やボタンのドロップシャドウが含まれることは問題ありません。ただし、隣接色に対するコントラスト比が3:1以上となるボタンのフチの色としてください。

![アイソレーションエリアに関するNG例が4つ示されている。左上はアクションボタンのすぐ下に別のボタンが接近しておりアイソレーションエリアを適切に確保できていないケースを示した画像、右上はアクションボタンのすぐ上に注釈が書かれておりアイソレーションエリアを適切に確保できていないケースを示した画像、左下はアクションボタンと背景色のコントラスト比が適切に確保されていない例、右下はアクションボタンと背景とのコントラスト比を適切に確保できてない例をそれぞれ示している。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/cb94bd2af50b42598e64b8f052d2ba44/auth-and-sign-design-guide-08.png)

#### サイズ

ボタンラベル、余白、角丸の半径、保護エリアについてのガイドラインを満たすサイズでアクションボタンを実装してください。

![ボタンラベルのフォントサイズの例。上段がフォントサイズ16pxの例。下段がフォントサイズ20pxの例。](https://images.microcms-assets.io/assets/7c793323a46a46b7bb9a2ac7d0023301/42581e41dc9c4c58bc33e1f80d3aa04b/auth-and-sign-design-guide-09.png)

利用者が、デジタル認証アプリを使って認証・署名することがはっきりとわかるよう、提供するサービスの画面には、デジタル認証アプリについての案内を表示します。デジタル認証アプリを用いた認証・署名を提供する場合はこのガイドラインに従ってください。

デザインガイドライン

システム連携ガイド（行政サービス向け）を見る