Skip to main content
POST
Create Signature

Headers

X-API-KEY
string
required

API key required for authentication

x-idempotency-key
string

Unique key to prevent duplicate signature creation

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>

Body

application/json

Input schema for creating a new signature. The parameters vary based on the signature type.

params
object
required

Parameters for a message signature

type
enum<string>
required
Available options:
message

Response

The signature has been successfully created.

approvals
object
required

Complete approval data including requirements, pending and submitted signatures

chainType
enum<string>
required

The blockchain type of the wallet

Available options:
aptos,
evm,
solana,
stellar,
sui
createdAt
required

ISO timestamp when the signature was created

id
string
required

Unique identifier for the signature

params
Auth entries signature parameters · object
required

Type-specific signature parameters

status
enum<string>
required

Current status of the signature

Available options:
awaiting-approval,
failed,
pending,
success
type
enum<string>
required

The type of signature

Available options:
auth-entries,
message,
typed-data
walletType
enum<string>
required

The wallet type (smart or mpc)

Available options:
mpc,
smart
completedAt

ISO timestamp when the transaction reached finality

error
any

Error message if the signature fails

outputSignature
string

The wallet's output signature of the request