Create Wallet

POST

2022-06-09

wallets

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/wallets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "type": "evm-smart-wallet",
  "config": {
    "adminSigner": {
      "type": "evm-keypair",
      "address": "0x1234567890123456789012345678901234567890"
    }
  },
  "linkedUser": "email:user@example.com"
}'

{
  "type": "evm-smart-wallet",
  "linkedUser": "email:user@example.com",
  "address": "0x1234567890123456789012345678901234567890",
  "config": {
    "adminSigner": {
      "type": "evm-keypair",
      "address": "0x1234567890123456789012345678901234567890",
      "locator": "evm-keypair:0x1234567890123456789012345678901234567890"
    }
  }
}

Headers

X-API-KEY

string

required

API key required for authentication

x-idempotency-key

string

Unique key to prevent duplicate wallet creation

Body

application/json

EVM smart wallet creation input

type

enum<string>

required

Available options:

evm-smart-wallet

config

object

config.adminSigner

object

required

An EOA external to Crossmint that can sign transactions

Example:

{
  "type": "evm-keypair",
  "address": "0x1234567890123456789012345678901234567890"
}

config.creationSeed

string

The unique wallet seed. By default, the seed is randomly generated.

Example:

"0"

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

EVM smart wallet creation input

type

enum<string>

required

Available options:

evm-smart-wallet

config

object

config.adminSigner

object

required

An EOA external to Crossmint that can sign transactions

Example:

{
  "type": "evm-keypair",
  "address": "0x1234567890123456789012345678901234567890"
}

config.creationSeed

string

The unique wallet seed. By default, the seed is randomly generated.

Example:

"0"

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Solana MPC wallet creation input

type

enum<string>

required

Available options:

solana-mpc-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Solana smart wallet creation input

type

enum<string>

required

Available options:

solana-smart-wallet

config

object

config.adminSigner

object

A Solana keypair external to Crossmint that can sign transactions

Example:

{
  "type": "solana-keypair",
  "address": "BKw3wMDoX4ZKuKkaHgPUqTqH3wqNGnwVAXrJ3MDWdZbL"
}

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Aptos MPC wallet creation input

type

enum<string>

required

Available options:

aptos-mpc-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Cardano MPC wallet creation input

type

enum<string>

required

Available options:

cardano-mpc-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Sui MPC wallet creation input

type

enum<string>

required

Available options:

sui-mpc-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Solana custodial wallet creation input (Deprecated: Use solana-mpc-wallet instead)

type

enum<string>

required

Available options:

solana-custodial-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

EVM MPC wallet creation input

type

enum<string>

required

Available options:

evm-mpc-wallet

config

any

linkedUser

string

A user locator can be of the format:

email:<email>
userId:<userId>
phoneNumber:<phoneNumber>
twitter:<handle>
x:<handle>

Example:

[
  "email:user@example.com",
  "userId:507f1f77bcf86cd799439011",
  "userId:did:example:cm4lr5piw0h6t1bjho0onryql",
  "phoneNumber:+12125551234",
  "twitter:johndoe",
  "x:@johndoe"
]

Response

201

application/json

Returns an existing wallet (200) if one already exists for the provided linkedUser or idempotencyKey, or creates and returns a new wallet (201). The response includes the wallet details and whether it was newly created.

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

evm-smart-wallet

config

object

required

EVM smart wallet type specific configuration settings

config.adminSigner

object

required

Configuration for an EVM keypair signer

Example:

{
  "type": "evm-keypair",
  "address": "0x1234567890123456789012345678901234567890",
  "locator": "evm-keypair:0x1234567890123456789012345678901234567890"
}

config.delegatedSigners

object[]

Optional array of additional signers for the wallet

Configuration for an EVM keypair signer

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

evm-smart-wallet

config

object

required

EVM smart wallet type specific configuration settings

config.adminSigner

object

required

Configuration for an EVM keypair signer

Example:

{
  "type": "evm-keypair",
  "address": "0x1234567890123456789012345678901234567890",
  "locator": "evm-keypair:0x1234567890123456789012345678901234567890"
}

config.delegatedSigners

object[]

Optional array of additional signers for the wallet

Configuration for an EVM keypair signer

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

solana-smart-wallet

config

object

required

Solana Smart wallet type specific configuration settings

config.adminSigner

object

required

Configuration for an Solana keypair signer

Example:

{
  "type": "solana-keypair",
  "address": "5vV8Vw7A2Eiu3mAi4T6Nurqqst1Zr3UYue8R2N1H8CFh",
  "locator": "solana-keypair:5vV8Vw7A2Eiu3mAi4T6Nurqqst1Zr3UYue8R2N1H8CFh"
}

config.delegatedSigners

object[]

Optional array of additional signers for the wallet

Complete delegated signer response including the signer and authorization transaction

config.delegatedSigners.type

enum<string>

required

Specifies the type of Solana signer being used, describing the method of key management and transaction signing.

Available options:

solana-keypair,

solana-fireblocks-custodial

config.delegatedSigners.locator

string

required

The locator of the signer

Example:

[
  "evm-keypair:0x1234567890123456789012345678901234567890",
  "evm-passkey:credential-id-123",
  "evm-fireblocks-custodial:0x1234567890123456789012345678901234567890",
  "solana-keypair:DUSTawucrTsGU8hcqRdHDCbuYhCPADMLM2VcCb8VnFnQ",
  "solana-fireblocks-custodial:DUSTawucrTsGU8hcqRdHDCbuYhCPADMLM2VcCb8VnFnQ"
]

config.delegatedSigners.transaction

object

required

The transaction for the signer

config.delegatedSigners.transaction.onChain

object

required

Solana smart wallet transaction data including input parameters and chain specific details

config.delegatedSigners.transaction.id

string

required

Unique identifier for the transaction

config.delegatedSigners.transaction.status

enum<string>

required

Current status of the transaction

Available options:

awaiting-approval,

pending,

failed,

success

config.delegatedSigners.transaction.createdAt

number

required

ISO timestamp when the transaction was created

Example:

"2024-01-01T00:00:00.000Z"

config.delegatedSigners.transaction.approvals

object

Complete approval data including requirements, pending and submitted signatures

config.delegatedSigners.transaction.completedAt

number

ISO timestamp when the transaction reached finality

Example:

"2024-01-01T00:00:00.000Z"

config.delegatedSigners.transaction.error

object

Error message if the transaction fails after submission

config.delegatedSigners.transaction.sendParams

object

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

solana-mpc-wallet

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

config

any

Solana MPC wallet type specific configuration settings

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

aptos-mpc-wallet

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

config

any

Aptos MPC wallet type specific configuration settings

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

cardano-mpc-wallet

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

config

any

Cardano MPC wallet type specific configuration settings

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

sui-mpc-wallet

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

config

any

Sui MPC wallet type specific configuration settings

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Complete wallet configuration including type-specific settings

type

enum<string>

required

The type of wallet configuration

Available options:

evm-mpc-wallet

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

linkedUser

string

The user that is linked to this wallet in format <locatorType>:<value>

Example:

"email:test@test.com"

createdAt

number

ISO timestamp of when the wallet was created

Example:

"2024-01-01T00:00:00.000Z"

Was this page helpful?

Introduction Get Wallet By Locator

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/wallets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "type": "evm-smart-wallet",
  "config": {
    "adminSigner": {
      "type": "evm-keypair",
      "address": "0x1234567890123456789012345678901234567890"
    }
  },
  "linkedUser": "email:user@example.com"
}'

{
  "type": "evm-smart-wallet",
  "linkedUser": "email:user@example.com",
  "address": "0x1234567890123456789012345678901234567890",
  "config": {
    "adminSigner": {
      "type": "evm-keypair",
      "address": "0x1234567890123456789012345678901234567890",
      "locator": "evm-keypair:0x1234567890123456789012345678901234567890"
    }
  }
}

API Reference

Wallets

NFTs

IP

NFT Collections

NFT Templates

Verifiable Credentials

Verifiable Credential Types

Headless Checkout

Action Status

Admin

Subscriptions

Headers

Body

Response