Function.useKeybanPassport

function useKeybanPassport(passportId: string): UsePromiseResult<
  | {
  actions: {
     enabled: boolean;
     icon?: string;
     id: string;
     label?: string;
     url?: string;
  }[];
  application: string;
  batchNumber: string | null;
  certificationStatus: "error" | "pending" | "certified";
  certifiedAt: Date | null;
  certifiedPaths: string[];
  createdAt: string;
  data: {
   [key: string]: unknown;
  };
  description?: string;
  editable: boolean;
  granularity: "model";
  id: string;
  images: {
     alt?: string;
     src: string;
  }[];
  ipfsCid: string | null;
  itemNumber: string | null;
  lastCertificateHash: string | null;
  modelNumber: string | null;
  name?: string;
  network:   | "EthereumAnvil"
     | "BaseSepolia"
     | "StarknetDevnet"
     | "StarknetSepolia"
     | "StarknetMainnet"
     | "StellarMainnet"
     | "StellarQuickstart"
     | "StellarTestnet";
  source: "manual" | "import" | "shopify";
  stats?: {
     batches: number;
     items: number;
  };
  status: "draft" | "published" | "archived";
  tokenId: string;
  updatedAt: string;
}
  | {
  actions: {
     enabled: boolean;
     icon?: string;
     id: string;
     label?: string;
     url?: string;
  }[];
  application: string;
  batchNumber: string | null;
  certificationStatus: "error" | "pending" | "certified";
  certifiedAt: Date | null;
  certifiedPaths: string[];
  createdAt: string;
  data: {
   [key: string]: unknown;
  };
  description?: string;
  editable: boolean;
  granularity: "batch";
  id: string;
  images: {
     alt?: string;
     src: string;
  }[];
  ipfsCid: string | null;
  itemNumber: string | null;
  lastCertificateHash: string | null;
  model?: {
     actions: {
        enabled: boolean;
        icon?: string;
        id: string;
        label?: string;
        url?: string;
     }[];
     application: string;
     batchNumber: string | null;
     certificationStatus: "error" | "pending" | "certified";
     certifiedAt: Date | null;
     certifiedPaths: string[];
     createdAt: string;
     data: {
      [key: string]: unknown;
     };
     description?: string;
     editable: boolean;
     granularity: "model";
     id: string;
     images: {
        alt?: string;
        src: string;
     }[];
     ipfsCid: string | null;
     itemNumber: string | null;
     lastCertificateHash: string | null;
     modelNumber: string | null;
     name?: string;
     network:   | "EthereumAnvil"
        | "BaseSepolia"
        | "StarknetDevnet"
        | "StarknetSepolia"
        | "StarknetMainnet"
        | "StellarMainnet"
        | "StellarQuickstart"
        | "StellarTestnet";
     source: "manual" | "import" | "shopify";
     stats?: {
        batches: number;
        items: number;
     };
     status: "draft" | "published" | "archived";
     tokenId: string;
     updatedAt: string;
  };
  modelNumber: string | null;
  name?: string;
  network:   | "EthereumAnvil"
     | "BaseSepolia"
     | "StarknetDevnet"
     | "StarknetSepolia"
     | "StarknetMainnet"
     | "StellarMainnet"
     | "StellarQuickstart"
     | "StellarTestnet";
  source: "manual" | "import" | "shopify";
  stats?: {
     items: number;
  };
  status: "draft" | "published" | "archived";
  tokenId: string;
  updatedAt: string;
}
  | {
  actions: {
     enabled: boolean;
     icon?: string;
     id: string;
     label?: string;
     url?: string;
  }[];
  allowedClaimEmail: string | null;
  allowedClaimPhoneNumber: string | null;
  application: string;
  batch?: {
     actions: {
        enabled: boolean;
        icon?: string;
        id: string;
        label?: string;
        url?: string;
     }[];
     application: string;
     batchNumber: string | null;
     certificationStatus: "error" | "pending" | "certified";
     certifiedAt: Date | null;
     certifiedPaths: string[];
     createdAt: string;
     data: {
      [key: string]: unknown;
     };
     description?: string;
     editable: boolean;
     granularity: "batch";
     id: string;
     images: {
        alt?: string;
        src: string;
     }[];
     ipfsCid: string | null;
     itemNumber: string | null;
     lastCertificateHash: string | null;
     model?: {
        actions: {
           enabled: boolean;
           icon?: string;
           id: string;
           label?: string;
           url?: string;
        }[];
        application: string;
        batchNumber: string | null;
        certificationStatus: "error" | "pending" | "certified";
        certifiedAt: Date | null;
        certifiedPaths: string[];
        createdAt: string;
        data: {
         [key: string]: unknown;
        };
        description?: string;
        editable: boolean;
        granularity: "model";
        id: string;
        images: {
           alt?: string;
           src: string;
        }[];
        ipfsCid: string | null;
        itemNumber: string | null;
        lastCertificateHash: string | null;
        modelNumber: string | null;
        name?: string;
        network:   | "EthereumAnvil"
           | "BaseSepolia"
           | "StarknetDevnet"
           | "StarknetSepolia"
           | "StarknetMainnet"
           | "StellarMainnet"
           | "StellarQuickstart"
           | "StellarTestnet";
        source: "manual" | "import" | "shopify";
        stats?: {
           batches: number;
           items: number;
        };
        status: "draft" | "published" | "archived";
        tokenId: string;
        updatedAt: string;
     };
     modelNumber: string | null;
     name?: string;
     network:   | "EthereumAnvil"
        | "BaseSepolia"
        | "StarknetDevnet"
        | "StarknetSepolia"
        | "StarknetMainnet"
        | "StellarMainnet"
        | "StellarQuickstart"
        | "StellarTestnet";
     source: "manual" | "import" | "shopify";
     stats?: {
        items: number;
     };
     status: "draft" | "published" | "archived";
     tokenId: string;
     updatedAt: string;
  };
  batchNumber: string | null;
  certificationStatus: "error" | "pending" | "certified";
  certifiedAt: Date | null;
  certifiedPaths: string[];
  createdAt: string;
  data: {
   [key: string]: unknown;
  };
  description?: string;
  editable: boolean;
  granularity: "item";
  id: string;
  images: {
     alt?: string;
     src: string;
  }[];
  ipfsCid: string | null;
  itemNumber: string | null;
  lastCertificateHash: string | null;
  mintedTo?: string | null;
  model?: {
     actions: {
        enabled: boolean;
        icon?: string;
        id: string;
        label?: string;
        url?: string;
     }[];
     application: string;
     batchNumber: string | null;
     certificationStatus: "error" | "pending" | "certified";
     certifiedAt: Date | null;
     certifiedPaths: string[];
     createdAt: string;
     data: {
      [key: string]: unknown;
     };
     description?: string;
     editable: boolean;
     granularity: "model";
     id: string;
     images: {
        alt?: string;
        src: string;
     }[];
     ipfsCid: string | null;
     itemNumber: string | null;
     lastCertificateHash: string | null;
     modelNumber: string | null;
     name?: string;
     network:   | "EthereumAnvil"
        | "BaseSepolia"
        | "StarknetDevnet"
        | "StarknetSepolia"
        | "StarknetMainnet"
        | "StellarMainnet"
        | "StellarQuickstart"
        | "StellarTestnet";
     source: "manual" | "import" | "shopify";
     stats?: {
        batches: number;
        items: number;
     };
     status: "draft" | "published" | "archived";
     tokenId: string;
     updatedAt: string;
  };
  modelNumber: string | null;
  name?: string;
  network:   | "EthereumAnvil"
     | "BaseSepolia"
     | "StarknetDevnet"
     | "StarknetSepolia"
     | "StarknetMainnet"
     | "StellarMainnet"
     | "StellarQuickstart"
     | "StellarTestnet";
  source: "manual" | "import" | "shopify";
  stats?: Record<string, never>;
  status: "draft" | "published" | "archived";
  tokenId: string;
  updatedAt: string;
}>;

Retrives a single product.

Parameters

Parameter	Type	Description
passportId	string	The identifier of the product

Returns

UsePromiseResult< | { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "model"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; } | { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "batch"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; model?: { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "model"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; }; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; } | { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; allowedClaimEmail: string | null; allowedClaimPhoneNumber: string | null; application: string; batch?: { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "batch"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; model?: { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "model"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; }; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; }; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "item"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; mintedTo?: string | null; model?: { actions: { enabled: boolean; icon?: string; id: string; label?: string; url?: string; }[]; application: string; batchNumber: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; createdAt: string; data: { [key: string]: unknown; }; description?: string; editable: boolean; granularity: "model"; id: string; images: { alt?: string; src: string; }[]; ipfsCid: string | null; itemNumber: string | null; lastCertificateHash: string | null; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; }; modelNumber: string | null; name?: string; network: | "EthereumAnvil" | "BaseSepolia" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; source: "manual" | "import" | "shopify"; stats?: Record<string, never>; status: "draft" | "published" | "archived"; tokenId: string; updatedAt: string; }>

• The result containing the passport or an error.