API Docs
v6.1.0
  • v6.1.0
  • v5.9.0
ガイドAPI仕様
よくある質問リリースノートお知らせ
ガイドAPI仕様
よくある質問リリースノートお知らせ
v6.1.0
  • v6.1.0
  • v5.9.0
SmartPOST APIドキュメント
v6.1.0
  • v6.1.0
  • v5.9.0
  1. 券面事項入力補助
  • APIの概要
  • システム概要
  • 認証＆認可API
    • 概要
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • 本人確認API
    • 概要
    • 利用者情報の検証方法
    • Userdata
      GET
  • 電子署名API
    • 概要
    • Signing
      POST
    • SigningRedirect
      POST
    • SigningStatus
      GET
    • Certificate
      GET
  • 本人確認情報更新API
    • 概要
    • Re:Verification
      POST
    • Re:VerificationRedirect
      POST
    • Re:VerificationStatus
      GET
  • 公的個人認証API
    • 概要
    • JPKI
      POST
    • JPKIRedirect
      POST
    • JPKIStatus
      GET
  • マイナポータル向け公的個人認証API
    • 概要
    • JPKIPittari
    • JPKIPittariRedirect
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助
    • 概要
    • CardInput
      POST
    • CardInputRedirect
      POST
    • CardInputStatus
      GET
  • マイナンバーAPI
    • 概要
    • MyNumber
    • MyNumberStatus
  1. 券面事項入力補助

概要

バージョン6.xの変更点#

共通#

Base URLが変更されています。
変更後のURL：https://api-uat.x-id.io/v6/
エラーレスポンスパラメータをerror_descriptionのみに統一しました。
一部のリクエスト/レスポンスにおいて、パラメータ名を下記の使い分けに従い変更しました。
CallbackとRedirectの使い分け
CallbackとRedirectは、どちらも特定の処理後に別の場所へ遷移するという点で似ていますが、次の定義を設け、使い分けております。
Redirect：あるURLから別のURLへブラウザを直接移動させる際に使用。
Callback：特定の処理（認証など）が完了した後に、元の場所（クライアント）に結果を通知する際に使用。

CardinputRedirect（旧CardinputCallback）#

URLパスを変更しました。
バージョン5.x以前：/cardinput/callback/request
バージョン6.x以降：/cardinput/redirect/request
リクエストパラメータ名を変更しました。
バージョン5.x以前：callback_url
バージョン6.x以降：redirect_url
※機能・動作に変更はありません。

本API群は、マイナンバーカードの券面事項入力補助APIを用いて、カード券面に記載されている、個人番号を除く基本四情報の提供を利用者に要求するためのものです。
以下のエンドポイントで構成されています。
CardInput（利用者への券面事項リクエストを発行する）
CardInputRedirect（利用者のモバイル端末に券面事項リクエストを発行する）
CardInputStatus（券面事項リクエストのステータスを取得する）
CardInputエンドポイントを使用することで、利用者のxIDアプリに券面事項入力補助要求（プッシュ通知）を送信し、マイナンバーを除く基本四情報を取得できます。

CardInputについて#

シーケンス#

利用者フロー#

cardinput-flow.png

CardInputRedirectについて#

CardInputエンドポイントとの違い#

主に下記の3点です。
本エンドポイントを用いてCardInputが開始された場合、自動的にxIDアプリへ遷移してプロセスが開始されます。
当該プロセスが完了した後、本要求を実行したクライアントアプリに自動的に戻ります。
xIDアプリからの自動遷移先はデフォルトブラウザとなります（特定のアプリへ遷移させたい場合の対策は下記のNoteを参照）。
注意
特定のアプリへ遷移が必要な場合は、CardInputRedirectリクエストのパラメータであるredirect_urlにクライアントアプリのユニバーサルリンクまたはアプリリンクを指定することをご検討ください。

リクエスト元からxIDアプリへの自動遷移#

レスポンスに含まれるredirect_urlを呼び出していただくことで、xIDアプリに自動遷移し、CardInputプロセスが開始されます。

xIDアプリからリクエスト元への自動遷移#

CardInputのプロセス終了後は、リクエスト時に指定されたURLへ自動遷移いたします。その際、当該手続きのステータスが付与されますので、ステータスに応じてリクエスト元でクライアントに表示する画面を制御することができます。

利用者が券面事項の読み取りを完了した場合#

自動遷移するURLにステータスfulfilledが付与されます。CardInputの詳細情報をCardInputStatusエンドポイントを用いて取得してください。セキュリティの観点から、利用者の個人情報とリクエストの対応状況はそれぞれ切り分けています。

シーケンス#

利用者フロー#

cardinput-mobile-flow.png
更新日時 2026-06-26 08:32:07
前へ
券面事項入力補助
次へ
CardInput
Built with