Skip to main content
GET
Get Delegated Signer

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>:<chainType>[:<walletType>][:alias:<alias>] (walletType defaults to 'smart')
  • userId:<userId>:<chainType>[:<walletType>][:alias:<alias>] (white label user example)
  • phoneNumber:<phoneNumber>:<chainType>[:<walletType>][:alias:<alias>]
  • twitter:<handle>:<chainType>[:<walletType>][:alias:<alias>]
  • x:<handle>:<chainType>[:<walletType>][:alias:<alias>]
  • me:<chainType>[:<walletType>][:alias:<alias>] (Use when calling from the client side with a client API key)
  • chainType[:<walletType>]:alias:<alias>
signer
string
required

The locator for the signer

Response

The delegated signer has been successfully retrieved.

Complete delegated signer response including the signer and authorizations for each chain

address
required

The blockchain address of the custodial signer

locator
string
required

The locator of the signer

type
enum<string>
required

Identifier for API key signer type

Available options:
api-key
chains
object

Authorization for each chain, keyed by chain name. The value is either a signature request (signature flow) or an on-chain registration transaction (deployImmediately flow).

expiresAt

The expiry date of the signer in ISO 8601 format

scopes
Transfer · object[]

Optional array of scopes restricting the signer's capabilities

Example: