xID V6 client APIs
v6.1.0
  • v6.1.0
  • v5.9.0
v6.1.0
  • v6.1.0
  • v5.9.0
v6.1.0
  • v6.1.0
  • v5.9.0
  1. マイナポータル向け公的個人認証
  • Introduction
  • 認可
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • 本人確認
    • Verification APIの変更点概要
    • 利用者情報の検証方法
    • Userdata
      GET
  • 電子署名
    • Signing APIの変更点概要
    • Signing
      POST
    • SigningStatus
      GET
    • Certificate
      GET
    • SigningRedirect
      POST
  • 本人確認情報更新
    • Reverification APIの変更点概要
    • Re:Verification
      POST
    • Re:VerificationStatus
      GET
    • Re:VerificationRedirect
      POST
  • 公的個人認証
    • JPKI APIの変更点概要
    • JPKI
      POST
    • JPKIStatus
      GET
    • JPKIRedirect
      POST
  • マイナポータル向け公的個人認証
    • JPKI Pittari APIの変更点概要
    • JPKIPittari
      POST
    • JPKIPittariRedirect
      POST
  • 利用者証明用証明書シリアル
    • Serial APIの変更点概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助
    • Cardinput APIの変更点概要
    • CardInput
    • CardInputStatus
    • CardInputRedirect
  • PressKits
    • クライアント・メディア向けプレスキット
  1. マイナポータル向け公的個人認証

JPKIPittari

POST
/v6/pittari/request
本APIを利用することで、マイナポータルを利用するユーザーが、xIDで公的個人認証を実施できるようになります。
対象となる署名値が複数存在する場合は、一括で署名を付します。

リクエストパラメータ

Authorization
Headerにパラメータ
Authorization
を追加し、その値にはBearerの後にTokenを連結します
例:
Authorization: Bearer ********************
リクエストボディパラメータapplication/json

例
{
    "primary_bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "reason": "〇〇のため公的個人認証を行なってください。",
    "isDigest": false,
    "notification_title": "公的個人認証のリクエストが届いています",
    "notification_description": "〇〇サービスから公的個人認証の要求が届いています。xIDアプリを開いて公的個人認証を行なってください。",
    "callback_url": "https://xid.inc"
}

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

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
リクエストリクエストExample
Shell
JavaScript
Java
Swift
curl --location 'https://api-uat.x-id.io/v6/pittari/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "primary_bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "reason": "〇〇のため公的個人認証を行なってください。",
    "isDigest": false,
    "notification_title": "公的個人認証のリクエストが届いています",
    "notification_description": "〇〇サービスから公的個人認証の要求が届いています。xIDアプリを開いて公的個人認証を行なってください。",
    "callback_url": "https://xid.inc"
}'

レスポンス

🟢200OK
application/json
Request created successfully
ボディapplication/json

例
{
    "request_id": "ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1",
    "is_renewed": false,
    "expires_in": 300
}
🟢200callback_urlへの応答
🟠400不正リクエスト
🟠401認証なし
🟠403権限不足
🔴500サーバー内部エラー
更新日時 2026-06-02 09:34:40
前へ
JPKI Pittari APIの変更点概要
次へ
JPKIPittariRedirect
Built with