xID for Developersへようこそ

xID for Developersでは、xID APIの仕様や、実装手順等を解説したドキュメントを開発者向けに公開しています。

xID APIの利用を開始する

以下の手順でxID APIの利用を開始することができます。

利用者情報暗号化のための鍵を生成する -> 利用者情報を暗号化する

当社に問い合わせのうえ、認可クライアントを発行する -> 認可クライアントを取得する

検証環境を用意する -> 検証環境を利用する

認可フローを実施し、アプリユーザーのアクセストークンを取得する -> アクセストークンを取得する

アクセストークンを使って任意のAPIリクエストを送信する -> xID API 仕様書

認可クライアント取得後、本サイトにて実際にxID APIの仕様を確認しながら各エンドポイントにリクエストを送ることができます。

ヒント

本サイトからAPIリクエストを送信するには、認可クライアント取得時にCORSを許可したいOriginに https://document.x-id.me/ を指定してください。

xIDはマイナンバーカードに関する様々なサービスを提供しています。各ページにてAPIリクエストのシーケンスや利用者の操作フローを確認できます。

API	詳細
認証＆認可	認証＆認可フローを実施し、利用者のアクセストークン、識別情報を取得します。
本人確認	クライアント向けに暗号化された利用者の個人情報を返却します。
電子署名	利用者にxIDアプリでの電子署名をリクエストします。
本人確認情報更新	xIDアカウントに登録されている利用者の本人確認情報を更新します。
公的個人認証	利用者にクライアント事業者（自治体）を署名検証者とした公的個人認証をリクエストします。
マイナポータル向け公的個人認証	マイナポータルを使用する利用者にxIDによる公的個人認証をリクエストします。
利用者証明用証明書シリアル	利用者に公的個人認証を要求し、マイナンバーカードの利用者証明用電子証明書に紐付けられたシリアル番号の提供をリクエストします。
券面事項入力補助	マイナンバーカードの券面事項入力補助APを用いて、マイナンバーを除く基本四情報の提供を利用者にリクエストします。