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の概要
  • システム概要
  • 認証＆認可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
      POST
    • JPKIPittariRedirect
      POST
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助
    • 概要
    • CardInput
    • CardInputRedirect
    • CardInputStatus
  • マイナンバーAPI
    • 概要
    • MyNumber
    • MyNumberStatus
  1. 電子署名API

概要

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

共通#

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

SigningRedirect（旧SigningCallback）#

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

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

Signingについて#

シーケンス#

利用者フロー#

signing-flow.png

SigningRedirectについて#

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

Signingリクエストとの違い#

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

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

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

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

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

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

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

シーケンス#

利用者フロー#

signing-mobile-flowpng.png
更新日時 2026-06-26 08:32:07
前へ
電子署名API
次へ
Signing
Built with