Get Wallet By Locator

Retrieves a wallet by its locator (address or user identifier and wallet type)

API scope required: wallets.read

Headers

X-API-KEY

string

required

API key required for authentication

Path Parameters

walletLocator

string

required

A wallet locator can be of the format:

• <walletAddress>
• email:<email>:<walletType>
• userId:<userId>:<walletType>
• userId:<userId>:<walletType> (white label user example)
• phoneNumber:<phoneNumber>:<walletType>
• twitter:<handle>:<walletType>
• x:<handle>:<walletType>

Response

200

application/json

The record has been successfully retreived.

• EVM smart wallet output
• Solana Smart wallet output
• Solana MPC wallet output
• Aptos MPC wallet output
• Cardano MPC wallet output
• Sui MPC wallet output
• EVM MPC wallet output

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

Show child attributes

config.adminSigner

object

required

Configuration for an EVM keypair signer

• EVM Keypair Signer
• EVM Custodial Signer
• Option 3

Show child attributes

config.adminSigner.type

enum<string>

required

Identifier for EVM keypair signer type

Available options:

evm-keypair

config.adminSigner.address

string

required

The Ethereum address of the external signer

config.adminSigner.locator

string

required

The locator of the signer

Example:

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

config.delegatedSigners

object[]

Optional array of additional signers for the wallet

• EVM Keypair Signer
• EVM Custodial Signer
• Option 3
• Option 4

Configuration for an EVM keypair signer

Show child attributes

config.delegatedSigners.type

enum<string>

required

Identifier for EVM keypair signer type

Available options:

evm-keypair

config.delegatedSigners.address

string

required

The Ethereum address of the external signer

config.delegatedSigners.locator

string

required

The locator of the 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:[e-mail]"

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

Show child attributes

config.adminSigner

object

required

Configuration for an EVM keypair signer

• EVM Keypair Signer
• EVM Custodial Signer
• Option 3

Show child attributes

config.adminSigner.type

enum<string>

required

Identifier for EVM keypair signer type

Available options:

evm-keypair

config.adminSigner.address

string

required

The Ethereum address of the external signer

config.adminSigner.locator

string

required

The locator of the signer

Example:

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

config.delegatedSigners

object[]

Optional array of additional signers for the wallet

• EVM Keypair Signer
• EVM Custodial Signer
• Option 3
• Option 4

Configuration for an EVM keypair signer

Show child attributes

config.delegatedSigners.type

enum<string>

required

Identifier for EVM keypair signer type

Available options:

evm-keypair

config.delegatedSigners.address

string

required

The Ethereum address of the external signer

config.delegatedSigners.locator

string

required

The locator of the 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:[e-mail]"

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

Show child attributes

config.adminSigner

object

required

Configuration for an Solana keypair signer

• Solana Keypair Signer
• Solana Custodial Signer

Show child attributes

config.adminSigner.type

enum<string>

required

Type identifier for Solana keypair signers

Available options:

solana-keypair

config.adminSigner.address

string

required

The Solana address of the signer

config.adminSigner.locator

string

required

The locator of the 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

Show child attributes

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

Show child attributes

config.delegatedSigners.transaction.onChain

object

required

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

Show child attributes

config.delegatedSigners.transaction.onChain.transaction

string

required

config.delegatedSigners.transaction.onChain.lastValidBlockHeight

number

config.delegatedSigners.transaction.onChain.txId

string

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

Show child attributes

config.delegatedSigners.transaction.approvals.pending

object[]

required

List of pending signatures

Show child attributes

config.delegatedSigners.transaction.approvals.submitted

object[]

required

Record of all submitted signatures

Show child attributes

config.delegatedSigners.transaction.approvals.required

number

Number of required approvals for the transaction

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

• Option 1
• Option 2
• Option 3

Show child attributes

config.delegatedSigners.transaction.error.reason

enum<string>

required

Available options:

build_failed,

failed_to_land_on_chain,

unknown,

sanctioned_wallet_address

config.delegatedSigners.transaction.error.message

string

required

config.delegatedSigners.transaction.sendParams

object

Show child attributes

config.delegatedSigners.transaction.sendParams.token

string

required

The token to send

config.delegatedSigners.transaction.sendParams.params

object

required

The parameters for the send token transaction

Show child attributes

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:[e-mail]"

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:[e-mail]"

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:[e-mail]"

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:[e-mail]"

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:[e-mail]"

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:[e-mail]"

createdAt

number

ISO timestamp of when the wallet was created

Example:

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