CardInputCallback

API-Document

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

POST

/v5/cardinput/callback/request

本エンドポイントはモバイル端末で利用されることを想定しています。xIDアプリの利用者にマイナンバーカードの券面事項の提供をリクエストすることができます。

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

Headers

ボディ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-02 08:17:04

CardInputStatus