SerialCallback

API-Document

https://api-uat.x-id.io

POST

/v5/serial/callback/request

本エンドポイントはモバイル端末で利用されることを想定しています。利用者証明用証明書シリアル番号を取得するためのエンドポイントです。

REQUIRED APP VERSION

本エンドポイントによってシリアル番号提供のリクエストを実施するには、利用者がv5.6.0以上のxIDアプリをインストールしている必要があります。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

リクエストボディパラメータapplication/json

例

{
    "bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。",
    "client_redirect_url": "https://xid.inc/home",
    "state": "{{$guid}}"
}

リクエストコードサンプル

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api-uat.x-id.io/v5/serial/callback/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。",
    "client_redirect_url": "https://xid.inc/home",
    "state": "{{$guid}}"
}'

レスポンス

🟢200成功

application/json

リクエスト送信後、利用者への要求に関するレスポンスが返されます。利用者のxIDアプリでの公的個人認証の操作が終わると、その結果（status）と利用者のserialを含む個人情報がクライアントアプリのcallback_urlに渡されます。callback_urlへの応答についてはcallback_urlへの応答にて詳細をご確認ください

加えて、xIDアプリからクライアントサービスのclient_redirect_urlへの自動遷移が発生します。自動遷移の際、xIDアプリはclient_redirect_urlに対して、パラメーターをGETメソッドで渡します。セキュリティの観点から署名値や証明書は付与せず、結果ステータスのみを渡します

client_redirect_urlへの応答例
https://example.com/mobile?request_id=ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1&state=lefzb8pcgb&status=certificate_verifiedKey

ボディapplication/json

例

{
  "request_id": "ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1",
  "is_renewed": false,
  "redirect_url": "https://x-id.me/sample?request_id=ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1",
  "expires_in": 0
}

🟢200callback_urlへの応答

🟠400不正リクエスト

🟠401認証なし

🟠403権限不足

🟠404未検出

🔴500サーバー内部エラー

更新日時 2026-06-02 08:27:54

Serial

CardInput