xID V6 client APIs
  1. v6
xID V6 client APIs
  • Openid
    • Authorization APIの変更点概要
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • Reverification
    • Reverification APIの変更点概要
    • v6
      • Re:VerificationStatus
      • Re:Verification
      • Re:VerificationRedirect
  • Serial
    • Serial APIの変更点概要
    • v6
      • Serial
      • SerialRedirect
  • Pittari
    • JPKI Pittari APIの変更点概要
    • v6
      • pittari
        • request
        • redirect
          • request
        • verify
      • JPKIPittari
        POST
      • JPKIPittariRedirect
        POST
  • Verification
    • Verification APIの変更点概要
    • v6
      • 利用者情報の検証方法
      • Userdata
  • Signing
    • Signing APIの変更点概要
    • v6
      • SigningStatus
      • Certificate
      • SigningRedirect
      • Signing
  • Cardinput
    • Cardinput APIの変更点概要
    • v6
      • CardInputStatus
      • Cardinput
      • CardinputRedirect
  • JPKI
    • JPKI APIの変更点概要
    • v6
      • JPKIStatus
      • JPKIRedirect
      • JPKI
  • スキーマ
    • Schemas
      • Pittari
        • _CheckSignatureRequest
        • _PittariVerifyRequest
        • _PostCreatePittariCallbackRequestResponse
        • _PostCreatePittariCallbackRequestV5Request
        • _PostCreatePittariRedirectRequestV6Request
        • _PostCreatePittariRequestRequest
        • _PostCreatePittariRequestResponse
        • _BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
        • PostCreatePittariResponse
        • PittariVerifyRequest
        • PostCreatePittariRedirectResponse
        • PostCreatePittariRequest
        • PostCreatePittariRedirectRequestV6
      • Signing
        • GetCertificateResponse
        • GetSigningStatusResponse
        • PostSigningCallbackRequestV5
        • PostSigningRedirectRequestV6
        • PostSigningRequest
        • PostSigningCallbackResponseV5
        • PostSigningRedirectResponse
        • BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
        • PostSigningResponse
      • Reverification
        • GetReverificationResponse
        • PostCreateReverificationRedirectResponse
        • PostCreateReverificationRequest
        • PostV5CreateReverificationRedirectRequest
        • PostV5ReverificationResponse
        • PostCreateReverificationRedirectResponseV6
        • PostReverificationResponseV6
        • PostV5ReverificationResponse
        • BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
      • Serial
        • PostCreateSerialCallbackRequestResponse
        • PostCreateSerialCallbackRequestV5Request
        • PostCreateSerialRedirectResponse
        • PostCreateSerialRedirectRequestV6
        • PostCreateSerialResponse
        • PostCreateSerialRequestV6
        • PostCreateSerialRequestV5Request
        • BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
      • JPKI
        • GetJPKIResponse
        • PostCreateJPKIRedirectRequestV6
        • PostCreateJPKIRedirectResponse
        • PostJPKIRequest
        • PostCreateJPKIRedirectRequestV5.
        • PostJPKIResponseV6
        • PostJPKIResponseV5
        • BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
      • Cardinput
        • _BadRequestErrorForV5Response
        • _GetCardinputStatusResponse
        • _PostCardinputCallbackRequestV5
        • _PostCardinputRedirectRequestV6
        • PostCardinputRedirectResponse
        • _Cardinput/PostCardinputRequest
        • PostCardinputResponse
        • _BadRequestErrorForV5Response
        • BadRequestErrorForV6Response
        • GetCardinputStatusResponse
        • PostCardinputRequest
        • PostCardinputRedirectRequestV6
      • mynumber / MR
        • PostV5MynumbercardRequest
        • GetMynumbercardResponseV5
        • PostV5MynumbercardResponse
        • BadRequestErrorForV5Response
      • Verification
        • GetUserDataResponseV6
        • BadRequestErrorForV5Response
        • GetUserDataResponseV5
      • Oidc
        • GetUserinfoResponse
        • PostTokenResponse
      • PostCreatePittariCallbackRequestV5Request
      • PostCardinputCallbackRequestV5
      • PostCardinputResponse
      • PostCardinputRedirectResponse
      • CheckSignatureRequest
    • Common
      • InternalServerError
  1. v6

JPKIPittariRedirect

テスト中
POST
/v6/pittari/redirect/request
本エンドポイントはモバイル端末で利用されることを想定しています。
マイナポータルを利用するユーザーが、xIDで公的個人認証を実施できるようになります。対象となる署名値が複数存在する場合は、一括で署名を付します。
リクエスト送信後、利用者への要求に関するレスポンスが返されます。
利用者のxIDアプリでの公的個人認証の操作が終わると、その結果(status)と request_id, signature, certificateがクライアントアプリのcallback_urlに渡されます。callback_urlへの応答についてはcallback_urlへの応答にて詳細をご確認ください
加えて、xIDアプリでの操作終了後、クライアントサービスの redirect_url への自動遷移が発生します。
自動遷移の際、xIDアプリは redirect_url に対して、以下の形式でパラメーターをGETメソッドで渡します。セキュリティの観点から署名値や証明書は付与せず、結果ステータスのみを渡します。
client_redirect_url への応答例
https://example.com/mobile?request_id=ilOAn2yR9T0IgRgxX...Y4k0ZEwyV9-vlkmOmp01NzoRST1&state=lefzb8pcgb&status=succeeded

リクエストパラメータ

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

例

レスポンス

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

🟠400不正な要求
🟠401権限なし
🔴500サーバーエラー
リクエストリクエストExample
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-uat.x-id.io/v6/pittari/redirect/request' \
--header 'Content-Type: application/json' \
--data-raw '{
    "primary_bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "reason": "test reason",
    "callback_url": "https://nifty-maintainer.info/",
    "redirect_url": "https://shallow-abacus.name/",
    "state": "{{$string.uuid}}"
}'
レスポンスレスポンスExample
200 - example-1
{
    "request_id": "req123",
    "expires_in": 3600,
    "is_renewed": false,
    "redirect_url": "http://example.com/redirect"
}
更新日時 2025-09-10 06:31:21
前へ
JPKIPittari
次へ
Verification APIの変更点概要
Built with