JPKIPittariCallback

API-Document

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

POST

/v5/pittari/callback/request

本エンドポイントはモバイル端末で利用されることを想定しています。マイナポータルを利用するユーザーが、xIDで公的個人認証を実施できるようになります。対象となる署名値が複数存在する場合は、一括で署名を付します。

REQUIRED APP VERSION

本エンドポイントによって本人確認情報更新を実施するには、利用者がv5.3.0以上のxIDアプリをインストールしている必要があります。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

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

例

{
    "primary_bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest":false,
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。",
    "state": "{{$string.uuid}}"
}

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api-uat.x-id.io/v5/pittari/callback/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "primary_bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest":false,
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。",
    "state": "{{$string.uuid}}"
}'

レスポンス

🟢200OK

application/json

リクエスト送信後、利用者への要求に関するレスポンスが返されます。利用者のxIDアプリでの公的個人認証の操作が終わると、その結果（status）と request_id, signature, certificateがクライアントアプリのcallback_urlに渡されます。callback_urlへの応答についてはcallback_urlへの応答にて詳細をご確認ください

加えて、xIDアプリでの操作終了後、クライアントサービスの client_redirect_url への自動遷移が発生します。自動遷移の際、xIDアプリは client_redirect_url に対して、以下の形式でパラメーターをGETメソッドで渡します。セキュリティの観点から署名値や証明書は付与せず、結果ステータスのみを渡します。

client_redirect_url への応答例
https://example.com/mobile?request_id=ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1&state=lefzb8pcgb&status=succeeded

ボディapplication/json

例

{
    "request_id": "string",
    "is_renewed": true,
    "redirect_url": "http://example.com",
    "expires_in": 0
}

🟢200callback_urlへの応答

🟠400不正リクエスト

🟠401認証なし

🟠403権限不足

🔴500サーバー内部エラー

更新日時 2026-06-02 06:56:17

JPKIPittari

Serial