Documentation

Apps

apps

Methods

Get App Settings ->
AppResponse
get/v1/apps/{app_id}

Get the settings and configuration for an app.

Get Test Credentials ->
TestAccountsResponse
get/v1/apps/{app_id}/test_credentials

Get the test accounts and credentials for an app.

Get Gas Spend ->
GasSpendResponseBody
get/v1/apps/gas_spend

Get aggregated Privy gas credits charged for a set of wallets over a time range. Maximum 100 wallet IDs and 30-day range per request.

Domain types

AllowlistDeletionResponse = { message }

Confirmation response for deleting an allowlist entry.

AllowlistEntry = { id, acceptedAt, appId, 2 more... }

An allowlist entry for an app.

AppResponse = { id, accent_color, allowed_domains, 55 more... }

The response for getting an app.

Caip2 = string

A valid CAIP-2 chain ID (e.g. 'eip155:1').

Currency = { chain, asset }

A crypto currency identified by a CAIP-2 chain ID and optional asset.

CurrencyAsset = "native-currency" | "USDC"

A currency asset type.

EmailDomain = string

An email domain.

EmailDomainInviteInput = { type, value }

Allowlist invite input for an email domain.

EmailInviteInput = { type, value }

Allowlist invite input for an email address.

EmbeddedWalletChainConfig = { create_on_login }

Chain-specific configuration for embedded wallets.

EmbeddedWalletConfigSchema =
EmbeddedWalletInputSchema

Configuration for embedded wallets including the mode.

EmbeddedWalletCreateOnLogin = "users-without-wallets" | "all-users" | "off"

Whether to create embedded wallets on login.

EmbeddedWalletInputSchema = { create_on_login, ethereum, solana, 3 more... }

Input configuration for embedded wallets.

EmbeddedWalletMode = "legacy-embedded-wallets-only" | "user-controlled-server-wallets-only"

The mode for embedded wallets.

FundingConfigResponseSchema = { cross_chain_bridging_enabled, default_recommended_amount, default_recommended_currency, 3 more... }

Configuration for funding and on-ramp options.

FundingMethodEnum = "moonpay" | "coinbase-onramp" | "external"

A funding method for on-ramp.

FundingOption = { method, provider }

A funding option with method and provider.

GasSpendCurrency = "usd"

Currency for gas spend values.

GasSpendRequestBody = { end_timestamp, start_timestamp, wallet_ids }

Query parameters for getting gas spend for a set of wallets. The time range from start_timestamp to end_timestamp must not exceed 30 days.

GasSpendResponseBody = { currency, value }

Aggregated Privy gas credits charged for a set of wallets over a time range.

PhoneInviteInput = { type, value }

Allowlist invite input for a phone number.

TelegramAuthConfigSchema = { bot_id, bot_name, link_enabled, 1 more... }

Configuration for Telegram authentication.

TestAccount = { id, created_at, email, 3 more... }

A test account for an app.

TestAccountsResponse = { data }

Response for listing test accounts for an app.

UserInviteInput =
EmailInviteInput
|
EmailDomainInviteInput
|
WalletInviteInput
| 1 more...

Input for adding or removing an allowlist entry. Discriminated by type.

UserOwnedRecoveryOption = "user-passcode" | "google-drive" | "icloud"

A user-owned recovery option for embedded wallets.

WalletInviteInput = { type, value }

Allowlist invite input for a wallet address.

Apps

Allowlist

apps.allowlist

Methods

List Allowlist Entries -> Array<
AllowlistEntry
>
get/v1/apps/{app_id}/allowlist

Get all allowlist entries for an app. Returns the list of users allowed to access the app when the allowlist is enabled.

path Parameters
app_id: string

The ID of the app.

Response fields
id: string
acceptedAt: number
Nullable
appId: string
type: string
value: string
Request example
200default
Add To Allowlist ->
AllowlistEntry
post/v1/apps/{app_id}/allowlist

Add a new entry to the allowlist for an app. The allowlist must be enabled.

Remove From Allowlist ->
AllowlistDeletionResponse
delete/v1/apps/{app_id}/allowlist

Remove an entry from the allowlist for an app. The allowlist must be enabled.

Domain types

AllowlistListResponse = Array<
AllowlistEntry
>