Skip to main content

Function.useKeybanProduct

function useKeybanProduct(productId: string): UsePromiseResult<{
application: string;
certifiedPaths: string[];
createdAt: string;
fields: {
[key: string]: unknown;
};
id: string;
name: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
passportsFields: (
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: {
name: "[]";
} &
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType | undefined;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: { name: "[]"; } & ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | ... 9 more ... | { ...; });
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }[];
label?: string;
name: string;
required?: boolean;
type: "object";
};
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: (
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: {
name: "[]";
} & { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; };
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; })[];
label?: string;
name: string;
required?: boolean;
type: "object";
})[];
label?: string;
name: string;
required?: boolean;
type: "object";
})[];
productFields: (
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: {
name: "[]";
} &
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType | undefined;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: { name: "[]"; } & ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | ... 9 more ... | { ...; });
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }[];
label?: string;
name: string;
required?: boolean;
type: "object";
};
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: (
| {
default?: number;
label?: string;
max?: number;
min?: number;
name: string;
required?: boolean;
type: "number";
}
| {
default?: string;
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "string";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "url";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "image";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "text";
}
| {
default?: boolean;
label?: string;
name: string;
required?: boolean;
type: "boolean";
}
| {
default?: string;
label?: string;
max?: string;
min?: string;
name: string;
required?: boolean;
type: "date";
}
| {
default?: string;
label?: string;
name: string;
required?: boolean;
type: "enum";
variants: string[];
}
| {
default?: JSONType;
label?: string;
name: string;
required?: boolean;
type: "json";
}
| {
default?: any[];
itemsType: {
name: "[]";
} & { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; };
label?: string;
maxLength?: number;
minLength?: number;
name: string;
required?: boolean;
type: "array";
}
| {
default?: Record<string, never>;
fields: ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; })[];
label?: string;
name: string;
required?: boolean;
type: "object";
})[];
label?: string;
name: string;
required?: boolean;
type: "object";
})[];
status: "ACTIVE" | "ARCHIVED" | "DRAFT" | "UNLISTED";
updatedAt: string;
}>;

Retrives a single product.

Parameters

ParameterTypeDescription
productIdstringThe identifier of the product

Returns

UsePromiseResult<{ application: string; certifiedPaths: string[]; createdAt: string; fields: { [key: string]: unknown; }; id: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; passportsFields: ( | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType | undefined; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | ... 9 more ... | { ...; }); label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }[]; label?: string; name: string; required?: boolean; type: "object"; }; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: ( | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; })[]; label?: string; name: string; required?: boolean; type: "object"; })[]; label?: string; name: string; required?: boolean; type: "object"; })[]; productFields: ( | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType | undefined; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | ... 9 more ... | { ...; }); label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }[]; label?: string; name: string; required?: boolean; type: "object"; }; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: ( | { default?: number; label?: string; max?: number; min?: number; name: string; required?: boolean; type: "number"; } | { default?: string; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "string"; } | { default?: string; label?: string; name: string; required?: boolean; type: "url"; } | { default?: string; label?: string; name: string; required?: boolean; type: "image"; } | { default?: string; label?: string; name: string; required?: boolean; type: "text"; } | { default?: boolean; label?: string; name: string; required?: boolean; type: "boolean"; } | { default?: string; label?: string; max?: string; min?: string; name: string; required?: boolean; type: "date"; } | { default?: string; label?: string; name: string; required?: boolean; type: "enum"; variants: string[]; } | { default?: JSONType; label?: string; name: string; required?: boolean; type: "json"; } | { default?: any[]; itemsType: { name: "[]"; } & { name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; }; label?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; type: "array"; } | { default?: Record<string, never>; fields: ({ name: string; type: "number"; label?: string | undefined; required?: boolean | undefined; min?: number | undefined; max?: number | undefined; default?: number | undefined; } | { name: string; ... 5 more ...; default?: string | undefined; } | ... 8 more ... | { ...; })[]; label?: string; name: string; required?: boolean; type: "object"; })[]; label?: string; name: string; required?: boolean; type: "object"; })[]; status: "ACTIVE" | "ARCHIVED" | "DRAFT" | "UNLISTED"; updatedAt: string; }>

  • The result containing the product or an error.