Skip to main content

Welcome

Welcome to the Privy docs! The documentation contains everything you need to get started using Privy's API. Want to try Privy? Get your API key!

info

Privy is currently in open beta. This means that while our security and infrastructure has been tested and hardened, we are still actively iterating on our interfaces and we welcome opinionated feedback (reach out via email (hi@privy.io) or Discord -- we want to know)!

What is Privy?โ€‹

Privy is a simple API that enables you to manage user data off-chain (e.g. their name, email address or KYC information). Privy helps you get rid of data silos and protect your users: you don't have to store or custody sensitive data yourself.

What if storing user data safely was literally as easy as storing it unencrypted in a database? Privy takes care of all the heavy lifting for you (client-side auth and encryption, key management, permissions handling) so you no longer have to worry about a data breach, accidentally leaking user data internally, or siloing it away.

Privy bridges web2 and web3 data so you can build delightful products and your users can stay in control of their information. The data is always encrypted client-side so Privy never sees it.

Privy handles storage, encryption, and access control so you can reclaim valuable development time and get back to building products that delight your users.

Using Privyโ€‹

You can integrate Privy into your front-end with just a few lines of code as shown below. Data is encrypted on the user's client device โ€” Privy never sees the plaintext data.

import {PrivyClient} from '@privy-io/privy-browser';

const client = new PrivyClient({
session: session,
});

// encrypt and save SSN for user with id '0x123'
const result = await client.put('0x123', {
field_id: 'ssn',
value: '123-45-6789',
});

Using Privy you can:

  • Keep sensitive data out of your of your stack,
  • Configure fine-grained access control to user data,
  • Clearly explain to users what data you are collecting and why.

Check out more use cases!

Start Building!โ€‹

Integrating Privy into your app takes just a few lines of code. Use the Quickstart guide to get started, check out common use cases or jump straight into the API References.

The Privy API is RESTful. It has intuitive, resource-oriented URLs, accepts JSON request bodies and returns JSON.

Moreโ€‹