JPKIRedirect

API-Document-v6

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

POST

/{{version}}/jpki/{{mobile_request_path}}/request

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

利用者のxIDアプリに対して、公的個人認証の実施要求を送信します。
利用者の操作状況はJPKIStatusで確認できます。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Headerパラメータ

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

例

{
    "bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "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/jpki/redirect/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。",
    "redirect_url": "https://xid.inc",
    "state": "{{$guid}}"
}'

レスポンス

🟢200成功

application/json

公的個人認証要求を受付した旨のレスポンスを返却します。

ボディapplication/json

例

{
    "request_id": "748eb404d1...4a025ba2f8",
    "redirect_url": "https://uat.x-id.me/xid?request_id=748eb404d1...4a025ba2f8&request_type=jpki",
    "expires_in": 299
}

🟠400不正リクエスト

🟠401認証なし

🔴500サーバー内部エラー

更新日時 2026-06-26 08:35:31

JPKI

JPKIStatus