Skip to main content

useIdentity

Get identity information for an Ethereum address.

Parameters

string
required
Ethereum address to query
object
Query options

Returns

Identity | null
The identity object or null if not found
boolean
Loading state
Error | null
Error object if request failed
function
Manually refetch identity

useMintIdentity

Mint a new ZKScore identity.

Parameters

object
Mutation options

Returns

function
Function to trigger the mint
boolean
Loading state
Error | null
Error object if mint failed
Identity | null
Minted identity data

useCheckUsername

Check if a username is available.

Returns

function
Function to check username availability
boolean | null
Whether username is available
boolean
Loading state

useActivateIdentity

Activate a minted identity.

Advanced Examples

Complete Identity Flow

Identity with Avatar

Batch Identity Loading

TypeScript Types

Next Steps

useScore

Learn about score hooks

useAchievements

Achievement hooks

Identity API

Identity API reference

Concepts

Learn about identities