利用者IDを用いて、当該利用者に発行された証明書のうちVerify APIが認識している最新の証明書について失効確認（現況確認）を行います。

署名検証時に確認した基本4情報（氏名、住所、生年月日、性別）に変更がないかどうかを確認（現況確認）する場合は、
署名検証時に利用者の特定を要求し、このとき発行される利用者IDを用いてこのAPIによる失効確認を行ってください。

利用者の特定を行わず、ある契約に署名した証明書が現時点で有効であるかを確認することもてきます。
この目的には証明書IDによる失効確認をご利用いただけます。

証明書の失効事由

certificate_status.revocation_reasonは、証明書が失効した事由を表します。

失効事由の詳細については、地方公共団体システム機構(J-LIS)が提供する認証局の運営情報の一部として公開されている署名用認証局運用規程(4.9.9. オンラインでの失効ステータス確認の適用性)および利用者証明用認証局運用規程(4.9.9. オンラインでの失効ステータス確認の適用性)をご参照ください。
以下に、当該規程に記載されている失効事由を示します。

`revocation_reason`	失効事由
`unspecified`	交付前に破棄した
`key_compromise`	利用者の秘密鍵が危殆化した
`ca_compromise`	CAの秘密鍵が危殆化した
`affiliation_changed`	証明書の記載内容に変更が生じた
`superseded`	証明書を更新した
`cessation_of_operation`	証明書の必要性がなくなった（使用しなくなった）
`certificate_hold`	秘密鍵の安全性に疑義が生じたため、証明書を一時的に保留した（一時保留の解除は行わない）

失効確認の方法

失効確認の方法は2通りから選択できます。
いずれの方法でも同じデータソースを参照していますが、更新のタイミング等が異なります。

また、料金の計算方法も異なります。
詳しくは料金体系(準備中)をご参照ください。

CRLファイルの参照

認証局より日時で取得したCRL（証明書失効リスト）ファイルの中に、検証対象の電子証明書が含まれているかどうかを確認します。

参照するCRLファイルは、毎朝7:30(日本時間)頃に更新されます。この時刻までは前日分のCRLファイルが参照されます。
CRLファイル更新作業は通常5〜10分程度を要し、この期間中は前日分のCRLファイルが参照される可能性があります。
確実に当日分の失効情報を確認したい場合は、OCSPによる問い合わせをご利用ください。

OCSPによる問い合わせ

認証局が運用するOCSPレスポンダに都度問い合わせを行い、証明書の状態を確認します。

失効確認の目的

署名検証の過程で実施された失効確認は、check_purpose が signature_verification (署名検証)として記録されます。
証明書データによる失効確認や証明書IDによる失効確認、利用者の現況確認の場合は、check_purpose が liveness_check (現況確認)として記録されます。

これらは、関係機関への報告のために利用されます。
また、PocketSign Verify APIの利用料金計算にも利用されます。

リクエストとレスポンスの詳細

Requestパラメータ

Pathパラメータ

string

必須

利用者ID

Request Bodyパラメータapplication/json

certificate_type

enum<string>

必須

証明書種別

列挙型:

jpki_card_digital_signaturejpki_card_user_authentication

status_check_method

enum<string>

必須

証明書の失効状態を確認する手段

列挙型:

crlocsp

例

{
  "certificate_type": "jpki_card_digital_signature",
  "status_check_method": "crl"
}

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response

🟢200OK

application/json

Body

certificate

object (Certificate)

必須

証明書データ

string <uuid>

必須

証明書ID

type

enum<string>

必須

証明書種別

列挙型:

jpki_card_digital_signaturejpki_card_user_authentication

latest

boolean

必須

現行世代の証明書かどうか

各利用者ごとに、同じ種別の証明書のうち最も発行された順番が新しいものを現行世代と呼び、それ以外の証明書は旧世代と呼びます。
証明書に紐付く利用者が特定されていない場合、旧世代の証明書として扱います。

created_at

string <date-time>

必須

証明書情報が保存された時刻

certificate_status

object (CertificateStatus)

必須

証明書失効状態の確認結果

string <uuid>

必須

証明書失効確認ID

status

enum<string>

必須

証明書の失効状態

列挙型:

goodrevoked

check_method

enum<string>

必須

証明書の失効状態を確認する手段

列挙型:

crlocsp

check_purpose

enum<string>

必須

証明書の失効状態を確認する目的

列挙型:

signature_verificationliveness_check

source_updated_at

string <date-time>

可選

証明書失効状態の確認に利用したデータソースの更新日時

CRLやOCSPレスポンスに含まれる thisUpdate に相当します。
CRLにシリアル番号が含まれない場合は設定されません。

revoked_at

string <date-time>

可選

失効した日時

失効していない場合は設定されません。

revocation_reason

enum<string>

可選

証明書の失効理由

この値は、RFC 5280 5.3.1に定義されるCRLReasonに対応します。
証明書が有効である場合には設定されません。

列挙型:

unspecifiedkey_compromiseca_compromiseaffiliation_changedsupersededcessation_of_operationcertificate_holdremove_from_crlprivilege_withdrawnaa_compromise

created_at

string <date-time>

必須

失効確認を行った時刻

user

object (User)

必須

利用者データ

string <uuid>

必須

利用者ID

created_at

string <date-time>

必須

利用者情報が保存された時刻

例

{
  "certificate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "jpki_card_digital_signature",
    "latest": true,
    "created_at": "2019-08-24T14:15:22Z"
  },
  "certificate_status": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "good",
    "check_method": "crl",
    "check_purpose": "signature_verification",
    "source_updated_at": "2019-08-24T14:15:22Z",
    "revoked_at": "2019-08-24T14:15:22Z",
    "revocation_reason": "unspecified",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

🟠400400

🟠401401

🟠404404

🔴500500

利用者の現況確認

証明書の失効事由#

失効確認の方法#

CRLファイルの参照#

OCSPによる問い合わせ#

失効確認の目的#

リクエストとレスポンスの詳細#

Requestパラメータ

サンプルコード

Response

証明書の失効事由

失効確認の方法

CRLファイルの参照

OCSPによる問い合わせ

失効確認の目的

リクエストとレスポンスの詳細