Cardinput

POST

/v6/cardinput/request

本エンドポイントによって、xIDアプリの利用者にマイナンバーカードの券面事項の提供をリクエストすることができます。
利用者の操作状況はCardInputStatusにて確認できます。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

レスポンス

🟢200OK

application/json

ボディapplication/json

🟠401権限なし

🟠400不正な要求

🔴500サーバーエラー

リクエストExample

Shell

JavaScript

Java

Swift

curl --location 'https://api-uat.x-id.io/v6/cardinput/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "扶養控除申告書記載のために実施してください",
    "notification_title": "券面情報の提供リクエストが届いています。",
    "notification_description": "〇〇サービスから券面情報の提供リクエストが届いています。xIDアプリを開いて券面情報の提供を行なってください。"
}'

レスポンスExample

200 - 例 1

{
    "request_id": "string",
    "expires_in": 0
}

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

CardInputStatus

CardinputRedirect