CardInputRedirect

POST

/v6/cardinput/redirect/request

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

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

{
    "redirect_url": "https://xid.inc",
    "state": "{{$string.uuid}}",
    "reason": "扶養控除申告書記載のために実施してください"
}

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "扶養控除申告書記載のために実施してください"
}'

レスポンス

🟢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 09:37:51

CardInputStatus

クライアント・メディア向けプレスキット