Skip to main content

Function.useKeybanPassportEvents

function useKeybanPassportEvents(passportId: string): UsePromiseResult<{
  createdAt: string;
  id: string;
  type: "create" | "update" | "publish" | "claim" | "scan" | "transfer";
}[]>;

Retrieves the certified ownership-chain events of a passport.

Public: returns the custody events of any published or claimed passport, oldest first. The events carry no identity (only a kind and a timestamp), so the result is safe to render to any viewer; decide separately whether the current user is the owner before labelling an event as "you".

Parameters​

ParameterTypeDescription
passportIdstringThe identifier of the passport

Returns​

UsePromiseResult<{ createdAt: string; id: string; type: "create" | "update" | "publish" | "claim" | "scan" | "transfer"; }[]>

  • The result containing the ownership events (oldest first) or an error.