DPP

Get certification key with registration status

Retrieve the active certification key for the organization, including its registration status from database records.

get/v1/dpp/certification-key

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/dpp/certification-key
  • Auth: X-Api-Key (a scheme the document does not define)

Response

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

organizationIdstring uuid required

Organization UUID

publicKeystring required

Public key in hex format, without a 0x prefix (legacy encoding kept for already-issued keys; EVM callers re-add the prefix).

status'active' | 'pending' | 'rotated' | 'revoked' required

Lifecycle status of the certification key. active: currently used for signing passports. pending: rotation in progress, not yet active. rotated: superseded by a newer key, kept for historical verification of past signatures. revoked: permanently invalidated (do not trust signatures).

namestring nullable

Optional key name for identification

activatedAtstring date-time required

When the key was activated

deactivatedAtstring date-time nullable

When the key was rotated or revoked

onChainStatus'registered' | 'pending' required

On-chain registration status: registered or pending

registeredNetworksstring[] required

Networks where the key is registered

explorerUrlstring uri nullable

Explorer URL for the registration transaction

Example response

{
  "rotation": {
    "newKeyId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.