Wallets

Create custodial wallet

Changed on

Create a new wallet custodied by a third-party provider.

post/v1/custodial_wallets

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/custodial_wallets
  • Auth
    HTTP basic

Headers

privy-app-idstring required

ID of your Privy app.

privy-idempotency-keystring

Idempotency keys ensure API requests are executed only once within a 24-hour window.

Request body

chain'base' | 'solana' | 'tempo' required

The chain of the custodial wallet.

provider_user_idstring required

The resource ID of the beneficiary of the custodial wallet, given by the licensing provider.

provider'bridge' required

The provider of the custodial wallet.

policy_idsstring[]

An optional list of up to one policy ID to enforce on the wallet.

Example request

{
  "chain": "tempo",
  "provider": "bridge",
  "provider_user_id": "1234567890"
}

Response

Newly created custodial wallet.

idstring required
addressstring required
chain'base' | 'solana' | 'tempo' required

The chain of the custodial wallet.

chain_type'ethereum' | 'solana'

Deprecated for custodial wallets. Use chain instead.

policy_idsstring[]
owner_idstring cuid2 required

A unique identifier for a key quorum.

Example response

{
  "id": "id2tptkqrxd39qo9j423etij",
  "address": "0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2",
  "chain": "tempo",
  "chain_type": "ethereum",
  "custody": {
    "provider": "bridge",
    "provider_user_id": "1234567890"
  },
  "policy_ids": [],
  "additional_signers": [],
  "owner_id": null
}

Changes

  • 4facbfa7f9d4Revision changes
    • breaking

      added the new required request property

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from string to no type for status

    • warning

      removed the request property

    • info

      added subschema #2 to the response property allOf list for the response status

    • info

      removed the ethereum enum value from the response property for the response status

    • info

      removed the solana enum value from the response property for the response status

    • info

      added the required property to the response with the status

  • 02e9839a74d4Revision changes
    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status