Cardinput

テスト中

POST

/v6/cardinput/request

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

リクエストパラメータ

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

例

レスポンス

🟢200OK

application/json

ボディ

🟠401権限なし

🟠400不正な要求

🔴500サーバーエラー

リクエストExample

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-uat.x-id.io/v6/cardinput/request' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "Cardinput request",
    "notification_title": "Sign Document",
    "notification_description": "Please sign the document"
}'

レスポンスExample

200 - 例 1

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

更新日時 2025-09-10 07:18:52

CardInputStatus

CardinputRedirect