Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.privy.io/llms.txt

Use this file to discover all available pages before exploring further.

Privy allows you to set custom metadata on the user object to store any app-specific metadata. This field is a generic JSON object up to 1KB in size. The JSON can contain arbitrary key-value pairs where the key is a string and value is a string, integer, or boolean (ie {username: 'name', isVerified: true, age: 23}). Privy supports two modes for writing custom metadata:
  • Set (replace): Replaces the entire custom_metadata object with the provided value. Any existing keys not included in the request are removed.
  • Update (partial): Performs a shallow merge of the provided keys into the existing custom_metadata object. Only the top-level keys you specify are updated; all unspecified keys are preserved.
Partial updates are currently only supported via the REST API. The Node.js, Java, Rust, and Go SDKs do not yet support this operation. SDK support is coming soon.