CardInputCallback

API-Document

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

POST

/v5/cardinput/callback/request

モバイル端末からの利用を想定したエンドポイントです。

利用者のxIDアプリに対して、マイナンバーカードの券面事項の提供要求を送信します。
利用者の操作状況はCardInputStatusで確認できます。

REQUIRED APP VERSION

利用者がv5.6.0以上のxIDアプリをインストールしている必要があります。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

{
    "callback_url": "https://xid.inc/home",
    "state": "{{$guid}}",
    "reason": "example reason"
}

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api-uat.x-id.io/v5/cardinput/callback/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "callback_url": "https://xid.inc/home",
    "state": "{{$guid}}",
    "reason": "example reason"
}'

レスポンス

🟢200OK

application/json

マイナンバーカードの券面事項の提供要求を受付した旨のレスポンスを返却します。

ボディapplication/json

例

{
    "request_id": "ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1",
    "redirect_url": "https://x-id.me/signing?request_id=ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1",
    "expires_in": 180
}

🟠400不正リクエスト

🟠401認証なし

🔴500サーバー内部エラー

更新日時 2026-06-05 09:27:19

CardInputStatus