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
  • APIの概要
  • システム構成
  • 認証&認可API
    • 概要
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • 本人確認API
    • 概要
    • Userdata
      GET
  • 電子署名API
    • 概要
    • Signing
      POST
    • SigningStatus
      GET
    • Certificate
      GET
    • SigningRedirect
      POST
  • 本人確認情報更新API
    • 概要
    • Re:Verification
      POST
    • Re:VerificationStatus
      GET
    • Re:VerificationRedirect
      POST
  • 公的個人認証API
    • 概要
    • JPKI
      POST
    • JPKIStatus
      GET
    • JPKIRedirect
      POST
  • マイナポータル向け公的個人認証API
    • 概要
    • JPKIPittari
      POST
    • JPKIPittariRedirect
      POST
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助API
    • 概要
    • CardInput
    • CardInputStatus
    • CardInputRedirect
  1. 電子署名API

概要

V6の変更点#

共通#

V6系APIのエントリポイント(Base URL:https://api-uat.x-id.io/v6/ )を更新しています。
Error Responseの場合、HTTP Status Codeとerror_descriptionが返送されます。
V6より下記通りCallbackとRedirectを定義し、各設定(Request, Responseなど)を更新しています。
CallbackとRedirectの命名規則
CallbackとRedirectは、どちらも特定の処理後に別の場所へ遷移するという点で似ていますが、以下定義を設けて、使い分けております。
Redirect:あるURLから別のURLへブラウザを直接移動させる際に使用。
Callback:特定の処理(認証など)が完了した後に、元の場所(クライアント)に結果を通知する際に使用。

SigningRedirect#

V5の/signing/callback/request を V6から/signing/redirect/request に変更しました。
Request で、 V5のcallback_urlをV6でredirect_urlに名称変更しました。機能面・動作面での変更はありません。

利用者のxIDアプリで電子署名を実施し、対応状況を取得するするためのAPIです。
このAPIは以下のエンドポイントで構成されています。
Signing(利用者への署名リクエストを発行する)
SigningStatus(署名リクエストのステータスを確認する)
Certificate(利用者のxID証明書を取得する)
SigningRedirect(利用者のモバイル端末への署名リクエストを発行する)
Signingエンドポイントに署名対象データを渡すことで、xIDアプリユーザーに署名のリクエストを送信することが可能です。
xIDアプリユーザーの署名状況(status)や、クライアントアプリの画面に表示する確認コード(verification_code)はSigningStatusエンドポイントで非同期で確認することができます。
Certificateエンドポイントで取得できるcertificate(証明書)は、署名完了後に署名の検証を行う際に必要となります。
モバイル端末でクライアントアプリを操作し、xID電子署名を開始する利用者フローが想定される場合は、SigningRedirectの活用をご検討ください。

Signingについて#

シーケンス#

利用者フロー#

signing-flow.png

SigningRedirectについて#

モバイルで端末で署名を開始する場合は、SigningRedirectエンドポイントを活用することでクライアントアプリ、xIDアプリ間の遷移の利便性を向上させることができます。
署名の操作前後でクライアントアプリケーション - xIDアプリ間の遷移が自動で行われるため、利用者がよりスムーズに操作を完結させることができます。

Signingリクエストとの違い#

Signingリクエストとの差分は以下の三点です。
本エンドポイントを用いて署名要求を実施した場合、自動的にxIDアプリへ遷移して署名プロセスが開始されます
当該署名が完了した後、署名要求を実行したサービスに自動的に戻ります
注意
xIDアプリから自動遷移して戻る先は、デフォルトブラウザがターゲットとなります。特定のアプリへ遷移が必要な場合は、クライアントアプリ側でユニバーサルリンク・アプリリンクを用いて、当該URLをredirect_urlに指定することをご検討ください。

クライアントアプリからxIDアプリへの自動遷移#

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

xIDアプリからクライアントアプリへの自動遷移#

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

利用者が署名を完了した場合#

自動遷移するURLにステータスsignedが付与されます。
署名の詳細情報をSignatureStatusエンドポイントを用いて取得してください。
セキュリティの観点から、ステータスと署名情報は分けて提供しています。

シーケンス#

利用者フロー#

signing-mobile-flowpng.png
更新日時 2026-06-05 09:59:13
前へ
電子署名API
次へ
Signing
Built with