CardinputRedirect

POST

/v6/cardinput/redirect/request

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

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

レスポンス

🟢200OK

application/json

Headers

ボディapplication/json

🟠400不正な要求

🟠401権限なし

🔴500サーバーエラー

リクエストExample

Shell

JavaScript

Java

Swift

curl --location 'https://api-uat.x-id.io/v6/cardinput/redirect/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "redirect_url": "https://xid.inc",
    "state": "{{$string.uuid}}",
    "reason": "扶養控除申告書記載のために実施してください"
}'

レスポンスExample

200 - 例 1

{
    "request_id": "req123",
    "expires_in": 3600,
    "redirect_url": "http://example.com/redirect"
}

更新日時 2026-05-11 23:54:59

Cardinput

JPKI APIの変更点概要