Schemas

Download schema

Session

session_id

string · required

Unique verification-session identifier.

session_url

string · uri · required

Widget URL to load in an iframe or WebView.

expires_at

string · date-time · required

Time at which the session expires. Use this value. A fixed session duration is not guaranteed.

ExchangeRequest

code

string · minLength: 1 · required

Single-use code from privy:success.payload.exchange_code.

ExchangeResult

session_id

string · required

event

string · const · required

Const value: identity.verified

token

string · required

Privy-signed EdDSA verified-data JWT.

JsonWebKeySet

Ed25519JsonWebKey[] · required

Ed25519JsonWebKey

kty

string · const · required

Const value: OKP

crv

string · const · required

Const value: Ed25519

alg

string · const · required

Const value: EdDSA

use

string · const · required

Const value: sig

kid

string · required

Key identifier from the JWT header.

x

string · required

Base64url-encoded Ed25519 public key.

Error

object · required

Privy Digital ID API

Schemas

Download schema

Session

session_id

string · required

Unique verification-session identifier.

session_url

string · uri · required

Widget URL to load in an iframe or WebView.

expires_at

string · date-time · required

Time at which the session expires. Use this value. A fixed session duration is not guaranteed.

ExchangeRequest

code

string · minLength: 1 · required

Single-use code from privy:success.payload.exchange_code.

ExchangeResult

session_id

string · required

event

string · const · required

Const value: identity.verified

token

string · required

Privy-signed EdDSA verified-data JWT.

JsonWebKeySet

Ed25519JsonWebKey[] · required

Ed25519JsonWebKey

kty

string · const · required

Const value: OKP

crv

string · const · required

Const value: Ed25519

alg

string · const · required

Const value: EdDSA

use

string · const · required

Const value: sig

kid

string · required

Key identifier from the JWT header.

x

string · required

Base64url-encoded Ed25519 public key.

Error

object · required