API Docs
v6.1.0
  • v5.9.0
  • v6.1.0
ガード
API仕様よくある質問
ガード
API仕様よくある質問
v6.1.0
  • v5.9.0
  • v6.1.0
v6.1.0
  • v5.9.0
  • v6.1.0
  1. APIの利用を開始する
  • xID for Developersへようこそ
  • APIの利用を開始する
    • 利用者情報を暗号化する
    • 認可クライアントを取得する
    • 検証環境を利用する
    • アクセストークンを取得する
    • DEV-Stable環境を利用する
  1. APIの利用を開始する

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

必要情報#

当社にて認可クライアントを発行いたします。利用用途に合わせて以下の情報を 所定の手続きにてご提供ください。
各項目の詳細については 提出情報詳細を確認してください。

提出情報サンプル#

項目例必須
クライアント名○○○サービス☆
クライアントアイコンhttps://public.x-id.me/logo.png☆
スコープopenid verification signing mynumber reverification jpki pittari serial cardinput☆
リダイレクトURLhttps://oidcdebugger.com/debug☆
CORSを許可したいOriginhttps://document.x-id.me/
クライアント利用規約https://public.x-id.me/terms.html☆
クライアントプライバシーポリシーhttps://public.x-id.me/privacy.html☆
公開鍵AmrL4PEn8Hx2eXNf10asc2ww+ZnVj3mZZxCGQu17Lwo=☆
クライアント企業名xID株式会社
クライアント企業ロゴhttps://public.xid.inc/logo.png
クライアント企業プライバシーポリシーhttps://public.xid.inc/docs/privacy.pdf
Token認証メソッドclient_secret_basic☆
マイナポータル向け公的個人認証リダイレクトURLhttps://example.com/result
マイナポータル向け公的個人認証リダイレクトURL for mobilehttps://example.com/mobileRedirect
利用者用証明書シリアルリダイレクトURLhttps://example.com/result
利用者用証明書シリアルリダイレクトURL for mobilehttps://example.com/mobileRedirect
SmartPOST Message API対象自治体黒須県黒須市

提出情報詳細#

クライアント名#

任意の文字列を設定できます。xIDを利用するサービス名など利用者情報が提供される先を設定してください。認可画面、および認可リクエストを受け取ったxIDアプリに当該クライアント名が表示されます。
client-name.png

クライアントアイコン#

アイコン画像にアクセス可能なURIを設定してください。「クライアント名」と併せて認可画面、および認可リクエストを受け取ったxIDアプリに表示されます。
client-icon.png
注意
.jpg .png .gif を指定可能
正方形推奨
背景透過画像は非推奨(xIDアプリのテーマによって画像の視認性が下がる可能性があります)

スコープ#

スコープは、xID APIの呼び出しやxIDでの機能を実行する権限をクライアントアプリケーションに付与するために使用します。設定可能なスコープは以下の10種類です。
例)openid verification signing jpki pittari serial cardinput sp_messages
スコープ説明
openid認可リクエストを可能にするスコープです。xID APIの利用に際して必ず必要となります。
verification本人確認に属するAPIを利用可能にします。
signing電子署名APIを利用可能にします。
mynumberマイナンバー要求に必要なスコープです。当スコープのご利用を希望の場合には、マイナンバーの収集の利用目的や保管について確認させていただく場合がございます。
reverification利用者に追加の身元確認を要求できるスコープです。
jpki公的個人認証を実施するために必要なスコープです。当該スコープのご利用を希望の場合には、クライアント事業者様自身が公的個人認証法における署名検証者である必要があります。
pittariマイナポータル利用時の公的個人認証を実施するために必要なスコープです。
serial利用者にマイナンバーカードの利用者証明用電子証明書のシリアル番号の提供を要求するために必要なスコープです。
cardinput利用者にマイナンバーカードの券面事項の提供を要求するために必要なスコープです。
sp_messagesSmartPOST Message API(メッセージ一覧、メッセージ内容を取得する等)を利用するためのスコープです。Message APIについて、の詳細は SmartPOST Message APIドキュメント をご確認ください

リダイレクト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://document.x-id.me/ )からAPIリクエストを送信するには、同URLを当項目に指定してください。

クライアント利用規約#

xID連携を行うクライアントサービスの規約を確認できるURLを指定します。検証環境利用時点ではアクセス可能なURLであれば任意のURLで問題ありません。当URLはクライアント名、クライアントアイコンと併せて認可画面に表示されます。
terms.png

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

xID連携を行うクライアントサービスのプライバシーポリシーを確認できるURLを指定します。検証環境利用時点ではアクセス可能なURLであれば任意のURLで問題ありません。当URLはクライアント名、クライアントアイコンと併せて認可画面に表示されます。
policy.png

公開鍵#

鍵生成手順に従って作成したECDSA公開鍵を提供してください。当該の鍵は利用者の個人情報を、当該クライアント向けに暗号化して提供する際に使用されます。当社への鍵の提供は 公開鍵のみの提供に限り 、秘密鍵は厳重な管理をお願い致します。

クライアント企業名#

「個人番号」、「本人確認情報更新」、「公的個人認証」、「マイナンバー提供」、「シリアル番号の提供」、「券面情報の提供」のリクエストを受け取ったxIDアプリに「クライアント企業ロゴ」「クライアント企業プライバシーポリシー」と併せて表示されます。
company-name.png
注意
mynumber reverification jpki pittari cardinput serial スコープをご利用の場合のみ提出

クライアント企業ロゴ#

「クライアントアイコン」と同様に URL をご提供ください。クライアントアイコンと企業ロゴが同一の場合には、クライアントアイコンと同一値で問題ありません。
当該画像は、「個人番号」、「本人確認情報更新」、「公的個人認証」、「マイナンバー提供」、「シリアル番号の提供」、「券面情報の提供」のリクエストを受け取ったxIDアプリに「クライアント企業プライバシーポリシー」と併せて表示されます。
company-logo.png
注意
mynumber reverification jpki pittari cardinput serial スコープをご利用の場合のみ提出

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

当該URLは、「個人番号」、「本人確認情報更新」、「公的個人認証」、「マイナンバー提供」、「シリアル番号の提供」、「券面情報の提供」のリクエストを受け取ったxIDアプリに「クライアント企業ロゴ」と併せて表示されます。
policy.png
注意
mynumber reverification jpki pittari cardinput serial スコープをご利用の場合のみ提出

Token認証メソッド#

未指定の場合は client_secret_basic が設定されます。当該値は、tokenエンドポイントに対する認証方式を指定するもので、デフォルトではbasic認証が用いられます。 指定可能な値は client_secret_basic もしくは client_secret_post です。
client_secret_postとは
client_secret_basicクライアント認証をサポートしていない認証サービス(Amazon Cognitoなど)を使用している場合には、認証メソッドとしてcleint_secret_postを指定してください。

マイナポータル向け公的個人認証リダイレクトURL#

マイナポータル向け公的個人認証のステータスが、変化した際、当該ステータスを含むレスポンスをクライアントサービスへリダイレクトする宛先です。詳細はJPKIPittari仕様を参照。

マイナポータル向け公的個人認証リダイレクトURL for mobile#

モバイル専用マイナポータル向け公的個人認証のステータスが、変化した際、当該ステータスを含むレスポンスと共にクライアントサービスへリダイレクトする宛先。WEBサービスの場合は、デフォルトBrowserへ遷移(deep linkも可能)。モバイルアプリ上でリダイレクトする為、画面が指定先のクライアントサービスへ切り替わります。詳細はJPKIPittariCallback仕様を参照。

利用者用証明書シリアルリダイレクトURL#

利用者用証明書シリアルAPIのステータスが、変化した際、当該ステータスを含むレスポンスをクライアントサービスへリダイレクトする宛先です。詳細はSerial仕様を参照。

利用者用証明書シリアルリダイレクトURL for mobile#

モバイル専用。利用者用証明書シリアルAPIのステータスが、変化した際、当該ステータスを含むレスポンスと共にクライアントサービスへリダイレクトする宛先です。WEBサービスの場合は、デフォルトBrowserへ遷移します(deep linkも可能)。モバイルアプリ上でリダイレクトする為、画面が指定先のクライアントサービスへ切り替わります。 詳細はSerialCallback仕様を参照。

SmartPOST Message API対象自治体#

SmartPOST Message APIで取得するメッセージの発行元を指定します。複数指定可能です。
SmartPOST管理画面の左上に表示されているアカウント名をご提供ください。
smartpost.png

必要情報のご連絡#

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

クライアント発行#

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

認可クライアント例#

認可クライアント情報に記載されているclient_id, client_secretを使って、xID APIの利用を開始できます。
まずは認証・認可フローを開始し、アクセストークンを取得して見ましょう。
注意
client_secretはaccess_token取得のBasic認証時(Token参照)に必要なパスワードです。クライアント側にてセキュアに保管してください。
{
  "client_id":"***",
  "client_name":"xIDサービス(検証用)",
  "client_secret":"***",
  "redirect_uris":[
    "https://oidcdebugger.com/debug"
  ],  
  "grant_types":[
    "authorization_code"
  ],
  "response_types":[
    "code"
  ],
  "scope":"openid verification signing mynumber reverification jpki",
  "audience":[],
  "owner":"",
  "policy_uri":"https://public.x-id.me/privacy.html",
  "allowed_cors_origins":[],
  "tos_uri":"https://public.x-id.me/terms.html",
  "client_uri":"", 
  "logo_uri":"https://public.x-id.me/logo.png",
  "client_secret_expires_at":0,
  "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":{
    "client_public_key":"AmrL4PEn8Hx2eXNf10asc2ww+ZnVj3mZZxCGQu17Lwo=", 
    "company_logo":"https://public.xid.inc/logo.png",
    "company_name":"xID株式会社",
    "company_privacy":"https://public.xid.inc/docs/privacy.pdf"
  }
}
更新日時 2026-06-05 04:35:25
前へ
利用者情報を暗号化する
次へ
検証環境を利用する
Built with