Cardinput

テスト中

POST

/v6/cardinput/request

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

Request 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"
}'

Response Example

200 - 例 1

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

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Request Bodyパラメータapplication/json

Examples

Response

🟢200OK

application/json

Body

🟠400不正な要求

🟠401権限なし

🔴500サーバーエラー

更新日時 2025-07-14 08:47:44

CardInputStatus

CardinputRedirect