xID Lite API Doc
ガイド
API仕様よくある質問リリースノート
ガイド
API仕様よくある質問リリースノート
  1. APIの利用を開始する
  • xID Lite for Developersへようこそ
  • APIの利用を開始する
    • クライアント統合要件: Private Key JWT
    • 認可クライアントを取得する
    • 検証環境を利用する
    • アクセストークンを取得する
  1. APIの利用を開始する

認可クライアントを取得する

xID Liteに提供する必要があるもの#

登録時に以下の情報をxID Liteに提供してください：
項目説明例
client_idxID Liteと合意したシステムの固有識別子testClient
jwks_uriJWKセット（公開鍵）がホストされているHTTPS URLhttps://backend.example.com/.well-known/jwks.json
scope常に cfjpkicfjpki
署名アルゴリズムJWTアサーションの署名に使用するアルゴリズムRS256, ES256 など
xID Liteは登録を確認後、以下の情報を提供します：
トークンエンドポイントのURL
APIのベースURL
client_id の確認

必要情報#

xID Liteにて認可クライアントを発行いたします。利用用途に合わせて以下の情報を 所定の手続きにてご提供ください。
各項目の詳細については 提出情報詳細を確認してください。
xID Liteは登録を確認後、以下の情報を提供します：
トークンエンドポイントのURL
APIのベースURL
client_id の確認

提出情報サンプル#

項目例必須
クライアントIDtestClient✓
スコープcfjpki dlc✓
リダイレクトURLhttps://oidcdebugger.com/debug✓
CORSを許可したいOriginhttps://api-docs-lite.x-id.me/
JWKセット（公開鍵）HTTPS URLhttps://backend.example.com/.well-known/jwks.json✓
署名アルゴリズムRS256, ES256 など✓
クライアント企業名xID株式会社
クライアント企業ロゴhttps://public.xid.inc/logo.png
クライアント企業プライバシーポリシーhttps://public.xid.inc/docs/privacy.pdf

提出情報詳細#

クライアント名#

xID Liteと合意したシステムの固有識別子。

スコープ#

スコープは、xID Lite APIの呼び出しやxIDでの機能を実行する権限をクライアントアプリケーションに付与するために使用します。設定可能なスコープは以下の2種類です。
例）cfjpki dlc
スコープ説明
cfjpki利用者にクライアント事業者（自治体）を署名検証者とした券面情報公的個人認証をリクエストします。
dlc利用者にクライアント事業者（自治体）を署名検証者とした運転免許証で認証をリクエストします。

リダイレクトURL#

認可リクエストに対する結果（成功・失敗）をコールバックするURLを指定します。当URLに追加のパラメーターが付された状態でリダイレクトされます。複数のリダイレクトURLも設定可能です。
制限事項
httpsから始まるURLを設定してください。localhostを使用する場合のみhttpを使用できます
クエリパラメータを含むURL、動的なURLは設定できません
セキュリティ上の観点から、本番環境におけるlocalhostを含んだリダイレクトURLの利用は禁止しております。IPアドレス127.0.0.1の指定も同様に禁止です

CORSを許可したいOrigin#

HTTPレスポンスヘッダの Access-Control-Allow-Origin に追加するURLを指定します。localhostなどをご利用の場合は、本項目から情報をご提供ください。
ヒント
APIドキュメントサイト（ https://api-docs-lite.x-id.me/ ）からAPIリクエストを送信するには、同URLを当項目に指定してください。

JWKセット（公開鍵）HTTPS URL#

非対称キーペアの生成に従って作成したJWKセット公開鍵を提供してください。当社への鍵の提供は 公開鍵のみの提供に限り 、秘密鍵は厳重な管理をお願い致します。

クライアント企業名#

「公的個人認証 + 券面検証」、「運転免許証検証」のリクエストを受け取ったxIDアプリに「クライアント企業ロゴ」「クライアント企業プライバシーポリシー」と併せて表示されます。
company-name.png

クライアント企業ロゴ#

「クライアントアイコン」と同様に URL をご提供ください。クライアントアイコンと企業ロゴが同一の場合には、クライアントアイコンと同一値で問題ありません。
当該画像は、「公的個人認証 + 券面検証」、「運転免許証検証」のリクエストを受け取ったxIDアプリに「クライアント企業プライバシーポリシー」と併せて表示されます。
company-logo.png

クライアント企業プライバシーポリシー#

当該URLは、「公的個人認証 + 券面検証」、「運転免許証検証」のリクエストを受け取ったxIDアプリに「クライアント企業ロゴ」と併せて表示されます。
policy.png

署名アルゴリズム#

非対称キーペアの生成に従ってJWTアサーションの署名に使用するアルゴリズム。

必要情報のご連絡#

弊社営業担当から共有された認可クライアント申請書に内容を記入の上、担当もしくは（api-sales@xid.inc）へメールにてご提出ください。
認可クライアント申請書をまだ入手していない場合は、コーポレートサイトお問い合わせフォームよりお問い合わせください。
注意
既にSlack等で連携させていただいている場合はそちらからのご連絡でも問題ありません。

クライアント発行#

いただいた情報をもとに、認可クライアントを発行します。発行までに最大3営業日をいただいております。

認可クライアント例#

認可クライアント情報に記載されているclient_id, token_uriを使って、xID APIの利用を開始できます。
まずは認証・認可フローを開始し、アクセストークンを取得して見ましょう。
{
  "client_id":"***",
  "redirect_uris":[
    "https://oidcdebugger.com/debug"
  ],  
  "grant_types":[
    "authorization_code"
  ],
  "response_types":[
    "code"
  ],
  "scope":"cfjpki dlc",
  "audience":[],
  "owner":"",
  "allowed_cors_origins":[],
  "jwks_uri":"https://backend.example.com/.well-known/jwks.json",
  "subject_type":"pairwise",
  "token_endpoint_auth_method":"client_secret_basic",
  "userinfo_signed_response_alg":"none",
  "created_at":"2021-11-18T14:02:29Z",
  "updated_at":"2021-11-19T01:58:05.489232Z",
  "metadata":{
    "company_logo":"https://public.xid.inc/logo.png",
    "company_name":"xID株式会社",
    "company_privacy":"https://public.xid.inc/docs/privacy.pdf"
  }
}
更新日時 2026-08-18 07:14:05
前へ
クライアント統合要件: Private Key JWT
次へ
検証環境を利用する
Built with