CardInputRedirect

API-Document-v6

https://uat-api.x-id.io

POST

/{{version}}/cardinput/{{mobile_request_path}}/request

モバイル端末からの利用を想定したエンドポイントです。

利用者のxIDアプリに対して、マイナンバーカードの券面事項の提供要求を送信します。
利用者の操作状況はCardInputStatusで確認できます。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

{
    "reason": "〇〇サービスにおける本人確認および、申請フォームへの基本情報（氏名・住所等）の自動入力補助を行うために、マイナンバーカードの券面事項を読み取ります。",
    "redirect_url": "https://xid.inc",
    "state": "{{$guid}}"
}

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://uat-api.x-id.io/v6/cardinput/redirect/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "〇〇サービスにおける本人確認および、申請フォームへの基本情報（氏名・住所等）の自動入力補助を行うために、マイナンバーカードの券面事項を読み取ります。",
    "redirect_url": "https://xid.inc",
    "state": "{{$guid}}"
}'

レスポンス

🟢200OK

application/json

マイナンバーカードの券面事項の提供要求を受付した旨のレスポンスを返却します。

ボディapplication/json

例

{
    "request_id": "3df6c49928...3bf682750f",
    "redirect_url": "https://uat.x-id.me/xid?request_id=3df6c49928...3bf682750f&request_type=cardinput",
    "expires_in": 1781080589
}

🟠400不正リクエスト

🟠401認証なし

🔴500サーバー内部エラー

更新日時 2026-06-26 08:36:11

CardInput

CardInputStatus