Documentation | Apps › Get Test Credentials

Apps

apps

Methods

Get App Settings ->

AppResponse

get/v1/apps/{app_id}

Get the settings and configuration for an app.

path Parameters

app_id: string

The ID of the app.

Response fields

AppResponse

Request example

curl https://api.privy.io/v1/apps/$APP_ID \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "id": "id",
  "accent_color": "accent_color",
  "allowed_domains": [
    "string"
  ],
  "allowed_native_app_ids": [
    "string"
  ],
  "allowed_native_app_url_schemes": [
    "string"
  ],
  "allowlist_config": {
    "cta_link": "cta_link",
    "cta_text": "cta_text",
    "error_detail": "error_detail",
    "error_title": "error_title"
  },
  "allowlist_enabled": true,
  "apple_oauth": true,
  "captcha_enabled": true,
  "custom_api_url": "custom_api_url",
  "custom_jwt_auth": true,
  "custom_oauth_providers": [
    {
      "enabled": true,
      "provider": "string",
      "provider_display_name": "provider_display_name",
      "provider_icon_url": "provider_icon_url"
    }
  ],
  "data_classification": "public",
  "disable_plus_emails": true,
  "discord_oauth": true,
  "email_auth": true,
  "embedded_wallet_config": {
    "create_on_login": "users-without-wallets",
    "ethereum": {
      "create_on_login": "users-without-wallets"
    },
    "solana": {
      "create_on_login": "users-without-wallets"
    },
    "user_owned_recovery_options": [
      "user-passcode"
    ],
    "require_user_owned_recovery_on_create": true,
    "require_user_password_on_create": true,
    "mode": "legacy-embedded-wallets-only"
  },
  "enabled_captcha_provider": "turnstile",
  "enforce_wallet_uis": true,
  "farcaster_auth": true,
  "farcaster_link_wallets_enabled": true,
  "fiat_on_ramp_enabled": true,
  "github_oauth": true,
  "google_oauth": true,
  "guest_auth": true,
  "icon_url": "icon_url",
  "instagram_oauth": true,
  "legacy_wallet_ui_config": true,
  "line_oauth": true,
  "linkedin_oauth": true,
  "logo_url": "logo_url",
  "max_linked_wallets_per_user": 0,
  "mfa_methods": [
    "sms"
  ],
  "name": "name",
  "passkey_auth": true,
  "passkeys_for_signup_enabled": true,
  "privacy_policy_url": "privacy_policy_url",
  "require_users_accept_terms": true,
  "show_wallet_login_first": true,
  "smart_wallet_config": {
    "enabled": false
  },
  "sms_auth": true,
  "solana_wallet_auth": true,
  "spotify_oauth": true,
  "telegram_auth": true,
  "telegram_oauth": true,
  "terms_and_conditions_url": "terms_and_conditions_url",
  "theme": "theme",
  "tiktok_oauth": true,
  "twitch_oauth": true,
  "twitter_oauth": true,
  "twitter_oauth_on_mobile_enabled": true,
  "verification_key": "verification_key",
  "wallet_auth": true,
  "wallet_connect_cloud_project_id": "wallet_connect_cloud_project_id",
  "whatsapp_enabled": true,
  "captcha_site_key": "captcha_site_key",
  "funding_config": {
    "cross_chain_bridging_enabled": true,
    "default_recommended_amount": "default_recommended_amount",
    "default_recommended_currency": {
      "chain": "-l-f12-k:_--l__36_",
      "asset": "native-currency"
    },
    "methods": [
      "moonpay"
    ],
    "options": [
      {
        "method": "method",
        "provider": "provider"
      }
    ],
    "prompt_funding_on_wallet_creation": true
  },
  "telegram_auth_config": {
    "bot_id": "bot_id",
    "bot_name": "bot_name",
    "link_enabled": true,
    "seamless_auth_enabled": true
  }
}

Get Test Credentials ->

TestAccountsResponse

get/v1/apps/{app_id}/test_credentials

Get the test accounts and credentials for an app.

path Parameters

app_id: string

The ID of the app.

Response fields

TestAccountsResponse

Request example

curl https://api.privy.io/v1/apps/$APP_ID/test_credentials \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "data": [
    {
      "id": "id",
      "created_at": "created_at",
      "email": "email",
      "otp_code": "otp_code",
      "phone_number": "phone_number",
      "updated_at": "updated_at"
    }
  ]
}

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.

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