Skip to main content
GET
Get Identity

Overview

Get detailed information about a ZKScore identity, including their ZKS ID, wallet address, activation status, and metadata.

Parameters

string
required
ZKS ID (e.g., alice.zks) or wallet address (e.g., 0x742d35Cc...)
ZKS ID Requirements: If using a ZKS ID, it must be activated (soulbound). The API will return the primary wallet address and aggregated data across all linked wallets.

Response

boolean
Indicates if the request was successful
string | null
The ZKS ID (without .zks suffix), or null if not set
string
The primary wallet address
object

Examples

Response Example

Error Responses

Use Cases

1. Profile Lookup

Use ZKS ID for a cleaner user experience:

2. Identity Verification

Check if an identity exists and is activated:

3. Address Resolution

Resolve a ZKS ID to a wallet address: