Skip to main content

Function.useKeybanPassportByReference

function useKeybanPassportByReference(reference: string): UsePromiseResult<{
actions: {
description?: Partial<Record<"en-US" | "fr-FR", string>>;
enabled: boolean;
icon?: string;
id: string;
label?: Partial<Record<"en-US" | "fr-FR", string>>;
type: "circularity" | "marketing";
url?: string;
}[];
allowedClaimEmail: string | null;
allowedClaimPhoneNumber: string | null;
application: string;
batch?: {
actions: {
description?: Partial<Record<"en-US" | "fr-FR", string>>;
enabled: boolean;
icon?: string;
id: string;
label?: Partial<Record<"en-US" | "fr-FR", string>>;
type: "circularity" | "marketing";
url?: string;
}[];
allowedClaimEmail: string | null;
allowedClaimPhoneNumber: string | null;
application: string;
batch?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined;
certificateSignature: string | null;
certificateUri: string | null;
certificationStatus: "error" | "pending" | "certified";
certifiedAt: Date | null;
certifiedPaths: string[];
completion: {
completed: number;
total: number;
};
createdAt: string;
data: {
[key: string]: unknown;
};
editable: boolean;
id: string;
ipfsCid: string | null;
lastCertificateHash: string | null;
mintedTo?: string | null;
model?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined;
network: | "EthereumAnvil"
| "BaseSepolia"
| "BaseMainnet"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
product: {
batchNumber?: string;
characteristics?: {
[key: string]: unknown;
};
countryOfProduction: {
countryCode: string;
countryName?: string;
};
description?: string;
dimensions?: {
height?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
length?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
volume?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
weight?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
width?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
};
id: string;
idGranularity: "model" | "batch" | "item";
idScheme: {
id: string;
name: string;
type: ["IdentifierScheme"];
};
itemNumber?: string;
materialProvenance?: {
hazardous?: boolean;
mass?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: ... | ...;
linkName: string;
linkType?: ... | ...;
linkURL: string;
mediaType?: ... | ...;
};
materialType: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: string;
};
recycledMassFraction?: number;
symbol?: {
description?: ... | ...;
imageData: string;
mediaType: string;
name: string;
};
}[];
modelNumber?: string;
name: string;
packaging?: {
description: string;
dimensions: {
height?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
length?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
volume?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
weight?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
width?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
};
materialUsed: {
hazardous?: boolean;
mass?: {
lowerTolerance?: ...;
unit: ...;
upperTolerance?: ...;
value: ...;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: ...;
linkName: ...;
linkType?: ...;
linkURL: ...;
mediaType?: ...;
};
materialType: {
code: string;
definition?: ... | ...;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: ... | ...;
};
recycledMassFraction?: number;
symbol?: {
description?: ...;
imageData: ...;
mediaType: ...;
name: ...;
};
}[];
packageLabel?: {
description?: ... | ...;
imageData: string;
mediaType: string;
name: string;
}[];
performanceClaim?: {
applicablePeriod?: ... | ...;
claimDate: string;
claimedPerformance: ...[];
conformityTopic: ...[];
description?: ... | ...;
evidence?: ... | ...;
id: string;
name: string;
referenceCriteria: ...[];
referenceRegulation?: ... | ...;
referenceStandard?: ... | ...;
type: [...];
}[];
};
performanceClaim?: {
applicablePeriod?: {
endDate: string;
periodInformation?: ... | ...;
startDate: string;
type: [...];
};
claimDate: string;
claimedPerformance: {
measure: {
lowerTolerance?: ...;
unit: ...;
upperTolerance?: ...;
value: ...;
};
metric: {
id: ...;
name: ...;
type: ...;
};
score: {
code: ...;
definition?: ...;
rank?: ...;
type: ...;
};
type: [...];
}[];
conformityTopic: {
definition?: ... | ...;
id: string;
name: string;
type: [...];
}[];
description?: string;
evidence?: {
digestMultibase?: ...;
linkName: ...;
linkType?: ...;
linkURL: ...;
mediaType?: ...;
}[];
id: string;
name: string;
referenceCriteria: {
id: string;
name: string;
type: [...];
}[];
referenceRegulation?: {
id: ...;
name: ...;
type: ...;
}[];
referenceStandard?: {
id: ...;
name: ...;
type: ...;
}[];
type: ["Claim"];
}[];
producedAtFacility: {
id: string;
name: string;
registeredId?: string;
type: ["Facility"];
};
productCategory: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
}[];
productImage?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
};
productionDate?: string;
productLabel?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
}[];
relatedDocument?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
}[];
relatedParty?: {
party: {
description?: string;
id: string;
idScheme?: {
id: ...;
name: ...;
type: ...;
};
industryCategory?: ...[];
name: string;
organisationWebsite?: string;
partyAddress?: {
addressCountry: ...;
addressLocality: ...;
addressRegion: ...;
postalCode: ...;
streetAddress: ...;
};
registeredId?: string;
registrationCountry?: {
countryCode: ...;
countryName?: ...;
};
type: ["Party"];
};
role: | "owner"
| "producer"
| "manufacturer"
| "processor"
| "remanufacturer"
| "recycler"
| "operator"
| "serviceProvider"
| "inspector"
| "certifier"
| "logisticsProvider"
| "carrier"
| "consignor"
| "consignee"
| "importer"
| "exporter"
| "distributor"
| "retailer"
| "brandOwner"
| "regulator";
}[];
type: ["Product"];
};
source: "manual" | "import" | "shopify";
stats?: {
batches: number;
items: number;
};
status: "draft" | "published" | "claimed" | "archived";
tokenId: string;
updatedAt: string;
vcStatus: {
credentialStatus: unknown;
issuer: | {
id: string;
name: string;
}
| null;
state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended";
validFrom: Date | null;
validUntil: Date | null;
};
vcUrl: string | null;
};
certificateSignature: string | null;
certificateUri: string | null;
certificationStatus: "error" | "pending" | "certified";
certifiedAt: Date | null;
certifiedPaths: string[];
completion: {
completed: number;
total: number;
};
createdAt: string;
data: {
[key: string]: unknown;
};
editable: boolean;
id: string;
ipfsCid: string | null;
lastCertificateHash: string | null;
mintedTo?: string | null;
model?: {
actions: {
description?: Partial<Record<"en-US" | "fr-FR", string>>;
enabled: boolean;
icon?: string;
id: string;
label?: Partial<Record<"en-US" | "fr-FR", string>>;
type: "circularity" | "marketing";
url?: string;
}[];
allowedClaimEmail: string | null;
allowedClaimPhoneNumber: string | null;
application: string;
batch?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined;
certificateSignature: string | null;
certificateUri: string | null;
certificationStatus: "error" | "pending" | "certified";
certifiedAt: Date | null;
certifiedPaths: string[];
completion: {
completed: number;
total: number;
};
createdAt: string;
data: {
[key: string]: unknown;
};
editable: boolean;
id: string;
ipfsCid: string | null;
lastCertificateHash: string | null;
mintedTo?: string | null;
model?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined;
network: | "EthereumAnvil"
| "BaseSepolia"
| "BaseMainnet"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
product: {
batchNumber?: string;
characteristics?: {
[key: string]: unknown;
};
countryOfProduction: {
countryCode: string;
countryName?: string;
};
description?: string;
dimensions?: {
height?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
length?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
volume?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
weight?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
width?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
};
id: string;
idGranularity: "model" | "batch" | "item";
idScheme: {
id: string;
name: string;
type: ["IdentifierScheme"];
};
itemNumber?: string;
materialProvenance?: {
hazardous?: boolean;
mass?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: ... | ...;
linkName: string;
linkType?: ... | ...;
linkURL: string;
mediaType?: ... | ...;
};
materialType: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: string;
};
recycledMassFraction?: number;
symbol?: {
description?: ... | ...;
imageData: string;
mediaType: string;
name: string;
};
}[];
modelNumber?: string;
name: string;
packaging?: {
description: string;
dimensions: {
height?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
length?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
volume?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
weight?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
width?: {
lowerTolerance?: ... | ...;
unit: string;
upperTolerance?: ... | ...;
value: number;
};
};
materialUsed: {
hazardous?: boolean;
mass?: {
lowerTolerance?: ...;
unit: ...;
upperTolerance?: ...;
value: ...;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: ...;
linkName: ...;
linkType?: ...;
linkURL: ...;
mediaType?: ...;
};
materialType: {
code: string;
definition?: ... | ...;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: ... | ...;
};
recycledMassFraction?: number;
symbol?: {
description?: ...;
imageData: ...;
mediaType: ...;
name: ...;
};
}[];
packageLabel?: {
description?: ... | ...;
imageData: string;
mediaType: string;
name: string;
}[];
performanceClaim?: {
applicablePeriod?: ... | ...;
claimDate: string;
claimedPerformance: ...[];
conformityTopic: ...[];
description?: ... | ...;
evidence?: ... | ...;
id: string;
name: string;
referenceCriteria: ...[];
referenceRegulation?: ... | ...;
referenceStandard?: ... | ...;
type: [...];
}[];
};
performanceClaim?: {
applicablePeriod?: {
endDate: string;
periodInformation?: ... | ...;
startDate: string;
type: [...];
};
claimDate: string;
claimedPerformance: {
measure: {
lowerTolerance?: ...;
unit: ...;
upperTolerance?: ...;
value: ...;
};
metric: {
id: ...;
name: ...;
type: ...;
};
score: {
code: ...;
definition?: ...;
rank?: ...;
type: ...;
};
type: [...];
}[];
conformityTopic: {
definition?: ... | ...;
id: string;
name: string;
type: [...];
}[];
description?: string;
evidence?: {
digestMultibase?: ...;
linkName: ...;
linkType?: ...;
linkURL: ...;
mediaType?: ...;
}[];
id: string;
name: string;
referenceCriteria: {
id: string;
name: string;
type: [...];
}[];
referenceRegulation?: {
id: ...;
name: ...;
type: ...;
}[];
referenceStandard?: {
id: ...;
name: ...;
type: ...;
}[];
type: ["Claim"];
}[];
producedAtFacility: {
id: string;
name: string;
registeredId?: string;
type: ["Facility"];
};
productCategory: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
}[];
productImage?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
};
productionDate?: string;
productLabel?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
}[];
relatedDocument?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
}[];
relatedParty?: {
party: {
description?: string;
id: string;
idScheme?: {
id: ...;
name: ...;
type: ...;
};
industryCategory?: ...[];
name: string;
organisationWebsite?: string;
partyAddress?: {
addressCountry: ...;
addressLocality: ...;
addressRegion: ...;
postalCode: ...;
streetAddress: ...;
};
registeredId?: string;
registrationCountry?: {
countryCode: ...;
countryName?: ...;
};
type: ["Party"];
};
role: | "owner"
| "producer"
| "manufacturer"
| "processor"
| "remanufacturer"
| "recycler"
| "operator"
| "serviceProvider"
| "inspector"
| "certifier"
| "logisticsProvider"
| "carrier"
| "consignor"
| "consignee"
| "importer"
| "exporter"
| "distributor"
| "retailer"
| "brandOwner"
| "regulator";
}[];
type: ["Product"];
};
source: "manual" | "import" | "shopify";
stats?: {
batches: number;
items: number;
};
status: "draft" | "published" | "claimed" | "archived";
tokenId: string;
updatedAt: string;
vcStatus: {
credentialStatus: unknown;
issuer: | {
id: string;
name: string;
}
| null;
state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended";
validFrom: Date | null;
validUntil: Date | null;
};
vcUrl: string | null;
};
network: | "EthereumAnvil"
| "BaseSepolia"
| "BaseMainnet"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
product: {
batchNumber?: string;
characteristics?: {
[key: string]: unknown;
};
countryOfProduction: {
countryCode: string;
countryName?: string;
};
description?: string;
dimensions?: {
height?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
length?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
volume?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
weight?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
width?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
};
id: string;
idGranularity: "model" | "batch" | "item";
idScheme: {
id: string;
name: string;
type: ["IdentifierScheme"];
};
itemNumber?: string;
materialProvenance?: {
hazardous?: boolean;
mass?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
};
materialType: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: string;
};
recycledMassFraction?: number;
symbol?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
};
}[];
modelNumber?: string;
name: string;
packaging?: {
description: string;
dimensions: {
height?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
length?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
volume?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
weight?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
width?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
};
materialUsed: {
hazardous?: boolean;
mass?: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
massFraction: number;
materialSafetyInformation?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
};
materialType: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
};
name: string;
originCountry: {
countryCode: string;
countryName?: string;
};
recycledMassFraction?: number;
symbol?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
};
}[];
packageLabel?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
}[];
performanceClaim?: {
applicablePeriod?: {
endDate: string;
periodInformation?: ... | ...;
startDate: string;
type: [...];
};
claimDate: string;
claimedPerformance: {
measure: {
lowerTolerance?: ...;
unit: ...;
upperTolerance?: ...;
value: ...;
};
metric: {
id: ...;
name: ...;
type: ...;
};
score: {
code: ...;
definition?: ...;
rank?: ...;
type: ...;
};
type: [...];
}[];
conformityTopic: {
definition?: ... | ...;
id: string;
name: string;
type: [...];
}[];
description?: string;
evidence?: {
digestMultibase?: ...;
linkName: ...;
linkType?: ...;
linkURL: ...;
mediaType?: ...;
}[];
id: string;
name: string;
referenceCriteria: {
id: string;
name: string;
type: [...];
}[];
referenceRegulation?: {
id: ...;
name: ...;
type: ...;
}[];
referenceStandard?: {
id: ...;
name: ...;
type: ...;
}[];
type: ["Claim"];
}[];
};
performanceClaim?: {
applicablePeriod?: {
endDate: string;
periodInformation?: string;
startDate: string;
type: ["Period"];
};
claimDate: string;
claimedPerformance: {
measure: {
lowerTolerance?: number;
unit: string;
upperTolerance?: number;
value: number;
};
metric: {
id: string;
name: string;
type: ["PerformanceMetric"];
};
score: {
code: string;
definition?: string;
rank?: number;
type: ["Score"];
};
type: ["Performance"];
}[];
conformityTopic: {
definition?: string;
id: string;
name: string;
type: ["ConformityTopic"];
}[];
description?: string;
evidence?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
}[];
id: string;
name: string;
referenceCriteria: {
id: string;
name: string;
type: ["Criterion"];
}[];
referenceRegulation?: {
id: string;
name: string;
type: ["Regulation"];
}[];
referenceStandard?: {
id: string;
name: string;
type: ["Standard"];
}[];
type: ["Claim"];
}[];
producedAtFacility: {
id: string;
name: string;
registeredId?: string;
type: ["Facility"];
};
productCategory: {
code: string;
definition?: string;
name: string;
schemeID: string;
schemeName: string;
}[];
productImage?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
};
productionDate?: string;
productLabel?: {
description?: string;
imageData: string;
mediaType: string;
name: string;
}[];
relatedDocument?: {
digestMultibase?: string;
linkName: string;
linkType?: string;
linkURL: string;
mediaType?: string;
}[];
relatedParty?: {
party: {
description?: string;
id: string;
idScheme?: {
id: string;
name: string;
type: ["IdentifierScheme"];
};
industryCategory?: {
code: string;
definition?: ... | ...;
name: string;
schemeID: string;
schemeName: string;
}[];
name: string;
organisationWebsite?: string;
partyAddress?: {
addressCountry: {
countryCode: string;
countryName?: ... | ...;
};
addressLocality: string;
addressRegion: string;
postalCode: string;
streetAddress: string;
};
registeredId?: string;
registrationCountry?: {
countryCode: string;
countryName?: string;
};
type: ["Party"];
};
role: | "owner"
| "producer"
| "manufacturer"
| "processor"
| "remanufacturer"
| "recycler"
| "operator"
| "serviceProvider"
| "inspector"
| "certifier"
| "logisticsProvider"
| "carrier"
| "consignor"
| "consignee"
| "importer"
| "exporter"
| "distributor"
| "retailer"
| "brandOwner"
| "regulator";
}[];
type: ["Product"];
};
source: "manual" | "import" | "shopify";
stats?: {
batches: number;
items: number;
};
status: "draft" | "published" | "claimed" | "archived";
tokenId: string;
updatedAt: string;
vcStatus: {
credentialStatus: unknown;
issuer: | {
id: string;
name: string;
}
| null;
state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended";
validFrom: Date | null;
validUntil: Date | null;
};
vcUrl: string | null;
}>;

Retrives a single product.

Parameters

ParameterTypeDescription
referencestringThe model/batch/item number

Returns

UsePromiseResult<{ actions: { description?: Partial<Record<"en-US" | "fr-FR", string>>; enabled: boolean; icon?: string; id: string; label?: Partial<Record<"en-US" | "fr-FR", string>>; type: "circularity" | "marketing"; url?: string; }[]; allowedClaimEmail: string | null; allowedClaimPhoneNumber: string | null; application: string; batch?: { actions: { description?: Partial<Record<"en-US" | "fr-FR", string>>; enabled: boolean; icon?: string; id: string; label?: Partial<Record<"en-US" | "fr-FR", string>>; type: "circularity" | "marketing"; url?: string; }[]; allowedClaimEmail: string | null; allowedClaimPhoneNumber: string | null; application: string; batch?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined; certificateSignature: string | null; certificateUri: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; completion: { completed: number; total: number; }; createdAt: string; data: { [key: string]: unknown; }; editable: boolean; id: string; ipfsCid: string | null; lastCertificateHash: string | null; mintedTo?: string | null; model?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined; network: | "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; product: { batchNumber?: string; characteristics?: { [key: string]: unknown; }; countryOfProduction: { countryCode: string; countryName?: string; }; description?: string; dimensions?: { height?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; length?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; volume?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; weight?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; width?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; }; id: string; idGranularity: "model" | "batch" | "item"; idScheme: { id: string; name: string; type: ["IdentifierScheme"]; }; itemNumber?: string; materialProvenance?: { hazardous?: boolean; mass?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: ... | ...; linkName: string; linkType?: ... | ...; linkURL: string; mediaType?: ... | ...; }; materialType: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: string; }; recycledMassFraction?: number; symbol?: { description?: ... | ...; imageData: string; mediaType: string; name: string; }; }[]; modelNumber?: string; name: string; packaging?: { description: string; dimensions: { height?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; length?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; volume?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; weight?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; width?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; }; materialUsed: { hazardous?: boolean; mass?: { lowerTolerance?: ...; unit: ...; upperTolerance?: ...; value: ...; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: ...; linkName: ...; linkType?: ...; linkURL: ...; mediaType?: ...; }; materialType: { code: string; definition?: ... | ...; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: ... | ...; }; recycledMassFraction?: number; symbol?: { description?: ...; imageData: ...; mediaType: ...; name: ...; }; }[]; packageLabel?: { description?: ... | ...; imageData: string; mediaType: string; name: string; }[]; performanceClaim?: { applicablePeriod?: ... | ...; claimDate: string; claimedPerformance: ...[]; conformityTopic: ...[]; description?: ... | ...; evidence?: ... | ...; id: string; name: string; referenceCriteria: ...[]; referenceRegulation?: ... | ...; referenceStandard?: ... | ...; type: [...]; }[]; }; performanceClaim?: { applicablePeriod?: { endDate: string; periodInformation?: ... | ...; startDate: string; type: [...]; }; claimDate: string; claimedPerformance: { measure: { lowerTolerance?: ...; unit: ...; upperTolerance?: ...; value: ...; }; metric: { id: ...; name: ...; type: ...; }; score: { code: ...; definition?: ...; rank?: ...; type: ...; }; type: [...]; }[]; conformityTopic: { definition?: ... | ...; id: string; name: string; type: [...]; }[]; description?: string; evidence?: { digestMultibase?: ...; linkName: ...; linkType?: ...; linkURL: ...; mediaType?: ...; }[]; id: string; name: string; referenceCriteria: { id: string; name: string; type: [...]; }[]; referenceRegulation?: { id: ...; name: ...; type: ...; }[]; referenceStandard?: { id: ...; name: ...; type: ...; }[]; type: ["Claim"]; }[]; producedAtFacility: { id: string; name: string; registeredId?: string; type: ["Facility"]; }; productCategory: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }[]; productImage?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }; productionDate?: string; productLabel?: { description?: string; imageData: string; mediaType: string; name: string; }[]; relatedDocument?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }[]; relatedParty?: { party: { description?: string; id: string; idScheme?: { id: ...; name: ...; type: ...; }; industryCategory?: ...[]; name: string; organisationWebsite?: string; partyAddress?: { addressCountry: ...; addressLocality: ...; addressRegion: ...; postalCode: ...; streetAddress: ...; }; registeredId?: string; registrationCountry?: { countryCode: ...; countryName?: ...; }; type: ["Party"]; }; role: | "owner" | "producer" | "manufacturer" | "processor" | "remanufacturer" | "recycler" | "operator" | "serviceProvider" | "inspector" | "certifier" | "logisticsProvider" | "carrier" | "consignor" | "consignee" | "importer" | "exporter" | "distributor" | "retailer" | "brandOwner" | "regulator"; }[]; type: ["Product"]; }; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "claimed" | "archived"; tokenId: string; updatedAt: string; vcStatus: { credentialStatus: unknown; issuer: | { id: string; name: string; } | null; state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended"; validFrom: Date | null; validUntil: Date | null; }; vcUrl: string | null; }; certificateSignature: string | null; certificateUri: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; completion: { completed: number; total: number; }; createdAt: string; data: { [key: string]: unknown; }; editable: boolean; id: string; ipfsCid: string | null; lastCertificateHash: string | null; mintedTo?: string | null; model?: { actions: { description?: Partial<Record<"en-US" | "fr-FR", string>>; enabled: boolean; icon?: string; id: string; label?: Partial<Record<"en-US" | "fr-FR", string>>; type: "circularity" | "marketing"; url?: string; }[]; allowedClaimEmail: string | null; allowedClaimPhoneNumber: string | null; application: string; batch?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined; certificateSignature: string | null; certificateUri: string | null; certificationStatus: "error" | "pending" | "certified"; certifiedAt: Date | null; certifiedPaths: string[]; completion: { completed: number; total: number; }; createdAt: string; data: { [key: string]: unknown; }; editable: boolean; id: string; ipfsCid: string | null; lastCertificateHash: string | null; mintedTo?: string | null; model?: { id: string; createdAt: string; updatedAt: string; application: string; network: "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; ... 22 more ...; stats?: { ...; } | undefined; } | undefined; network: | "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; product: { batchNumber?: string; characteristics?: { [key: string]: unknown; }; countryOfProduction: { countryCode: string; countryName?: string; }; description?: string; dimensions?: { height?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; length?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; volume?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; weight?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; width?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; }; id: string; idGranularity: "model" | "batch" | "item"; idScheme: { id: string; name: string; type: ["IdentifierScheme"]; }; itemNumber?: string; materialProvenance?: { hazardous?: boolean; mass?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: ... | ...; linkName: string; linkType?: ... | ...; linkURL: string; mediaType?: ... | ...; }; materialType: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: string; }; recycledMassFraction?: number; symbol?: { description?: ... | ...; imageData: string; mediaType: string; name: string; }; }[]; modelNumber?: string; name: string; packaging?: { description: string; dimensions: { height?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; length?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; volume?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; weight?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; width?: { lowerTolerance?: ... | ...; unit: string; upperTolerance?: ... | ...; value: number; }; }; materialUsed: { hazardous?: boolean; mass?: { lowerTolerance?: ...; unit: ...; upperTolerance?: ...; value: ...; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: ...; linkName: ...; linkType?: ...; linkURL: ...; mediaType?: ...; }; materialType: { code: string; definition?: ... | ...; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: ... | ...; }; recycledMassFraction?: number; symbol?: { description?: ...; imageData: ...; mediaType: ...; name: ...; }; }[]; packageLabel?: { description?: ... | ...; imageData: string; mediaType: string; name: string; }[]; performanceClaim?: { applicablePeriod?: ... | ...; claimDate: string; claimedPerformance: ...[]; conformityTopic: ...[]; description?: ... | ...; evidence?: ... | ...; id: string; name: string; referenceCriteria: ...[]; referenceRegulation?: ... | ...; referenceStandard?: ... | ...; type: [...]; }[]; }; performanceClaim?: { applicablePeriod?: { endDate: string; periodInformation?: ... | ...; startDate: string; type: [...]; }; claimDate: string; claimedPerformance: { measure: { lowerTolerance?: ...; unit: ...; upperTolerance?: ...; value: ...; }; metric: { id: ...; name: ...; type: ...; }; score: { code: ...; definition?: ...; rank?: ...; type: ...; }; type: [...]; }[]; conformityTopic: { definition?: ... | ...; id: string; name: string; type: [...]; }[]; description?: string; evidence?: { digestMultibase?: ...; linkName: ...; linkType?: ...; linkURL: ...; mediaType?: ...; }[]; id: string; name: string; referenceCriteria: { id: string; name: string; type: [...]; }[]; referenceRegulation?: { id: ...; name: ...; type: ...; }[]; referenceStandard?: { id: ...; name: ...; type: ...; }[]; type: ["Claim"]; }[]; producedAtFacility: { id: string; name: string; registeredId?: string; type: ["Facility"]; }; productCategory: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }[]; productImage?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }; productionDate?: string; productLabel?: { description?: string; imageData: string; mediaType: string; name: string; }[]; relatedDocument?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }[]; relatedParty?: { party: { description?: string; id: string; idScheme?: { id: ...; name: ...; type: ...; }; industryCategory?: ...[]; name: string; organisationWebsite?: string; partyAddress?: { addressCountry: ...; addressLocality: ...; addressRegion: ...; postalCode: ...; streetAddress: ...; }; registeredId?: string; registrationCountry?: { countryCode: ...; countryName?: ...; }; type: ["Party"]; }; role: | "owner" | "producer" | "manufacturer" | "processor" | "remanufacturer" | "recycler" | "operator" | "serviceProvider" | "inspector" | "certifier" | "logisticsProvider" | "carrier" | "consignor" | "consignee" | "importer" | "exporter" | "distributor" | "retailer" | "brandOwner" | "regulator"; }[]; type: ["Product"]; }; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "claimed" | "archived"; tokenId: string; updatedAt: string; vcStatus: { credentialStatus: unknown; issuer: | { id: string; name: string; } | null; state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended"; validFrom: Date | null; validUntil: Date | null; }; vcUrl: string | null; }; network: | "EthereumAnvil" | "BaseSepolia" | "BaseMainnet" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; product: { batchNumber?: string; characteristics?: { [key: string]: unknown; }; countryOfProduction: { countryCode: string; countryName?: string; }; description?: string; dimensions?: { height?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; length?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; volume?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; weight?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; width?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; }; id: string; idGranularity: "model" | "batch" | "item"; idScheme: { id: string; name: string; type: ["IdentifierScheme"]; }; itemNumber?: string; materialProvenance?: { hazardous?: boolean; mass?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }; materialType: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: string; }; recycledMassFraction?: number; symbol?: { description?: string; imageData: string; mediaType: string; name: string; }; }[]; modelNumber?: string; name: string; packaging?: { description: string; dimensions: { height?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; length?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; volume?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; weight?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; width?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; }; materialUsed: { hazardous?: boolean; mass?: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; massFraction: number; materialSafetyInformation?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }; materialType: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }; name: string; originCountry: { countryCode: string; countryName?: string; }; recycledMassFraction?: number; symbol?: { description?: string; imageData: string; mediaType: string; name: string; }; }[]; packageLabel?: { description?: string; imageData: string; mediaType: string; name: string; }[]; performanceClaim?: { applicablePeriod?: { endDate: string; periodInformation?: ... | ...; startDate: string; type: [...]; }; claimDate: string; claimedPerformance: { measure: { lowerTolerance?: ...; unit: ...; upperTolerance?: ...; value: ...; }; metric: { id: ...; name: ...; type: ...; }; score: { code: ...; definition?: ...; rank?: ...; type: ...; }; type: [...]; }[]; conformityTopic: { definition?: ... | ...; id: string; name: string; type: [...]; }[]; description?: string; evidence?: { digestMultibase?: ...; linkName: ...; linkType?: ...; linkURL: ...; mediaType?: ...; }[]; id: string; name: string; referenceCriteria: { id: string; name: string; type: [...]; }[]; referenceRegulation?: { id: ...; name: ...; type: ...; }[]; referenceStandard?: { id: ...; name: ...; type: ...; }[]; type: ["Claim"]; }[]; }; performanceClaim?: { applicablePeriod?: { endDate: string; periodInformation?: string; startDate: string; type: ["Period"]; }; claimDate: string; claimedPerformance: { measure: { lowerTolerance?: number; unit: string; upperTolerance?: number; value: number; }; metric: { id: string; name: string; type: ["PerformanceMetric"]; }; score: { code: string; definition?: string; rank?: number; type: ["Score"]; }; type: ["Performance"]; }[]; conformityTopic: { definition?: string; id: string; name: string; type: ["ConformityTopic"]; }[]; description?: string; evidence?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }[]; id: string; name: string; referenceCriteria: { id: string; name: string; type: ["Criterion"]; }[]; referenceRegulation?: { id: string; name: string; type: ["Regulation"]; }[]; referenceStandard?: { id: string; name: string; type: ["Standard"]; }[]; type: ["Claim"]; }[]; producedAtFacility: { id: string; name: string; registeredId?: string; type: ["Facility"]; }; productCategory: { code: string; definition?: string; name: string; schemeID: string; schemeName: string; }[]; productImage?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }; productionDate?: string; productLabel?: { description?: string; imageData: string; mediaType: string; name: string; }[]; relatedDocument?: { digestMultibase?: string; linkName: string; linkType?: string; linkURL: string; mediaType?: string; }[]; relatedParty?: { party: { description?: string; id: string; idScheme?: { id: string; name: string; type: ["IdentifierScheme"]; }; industryCategory?: { code: string; definition?: ... | ...; name: string; schemeID: string; schemeName: string; }[]; name: string; organisationWebsite?: string; partyAddress?: { addressCountry: { countryCode: string; countryName?: ... | ...; }; addressLocality: string; addressRegion: string; postalCode: string; streetAddress: string; }; registeredId?: string; registrationCountry?: { countryCode: string; countryName?: string; }; type: ["Party"]; }; role: | "owner" | "producer" | "manufacturer" | "processor" | "remanufacturer" | "recycler" | "operator" | "serviceProvider" | "inspector" | "certifier" | "logisticsProvider" | "carrier" | "consignor" | "consignee" | "importer" | "exporter" | "distributor" | "retailer" | "brandOwner" | "regulator"; }[]; type: ["Product"]; }; source: "manual" | "import" | "shopify"; stats?: { batches: number; items: number; }; status: "draft" | "published" | "claimed" | "archived"; tokenId: string; updatedAt: string; vcStatus: { credentialStatus: unknown; issuer: | { id: string; name: string; } | null; state: "error" | "pending" | "valid" | "expired" | "revoked" | "suspended"; validFrom: Date | null; validUntil: Date | null; }; vcUrl: string | null; }>

  • The result containing the passport or an error.