Get Signature

GET

2022-06-09

wallets

{walletLocator}

signatures

{signatureId}

curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/wallets/{walletLocator}/signatures/{signatureId} \
  --header 'X-API-KEY: <x-api-key>'

{
  "id": "tx-b984491a-5785-43c0-8811-45d46fe6e520",
  "walletType": "evm-smart-wallet",
  "type": "evm-message",
  "status": "awaiting-approval",
  "params": {
    "message": "Hello, world!",
    "signer": "evm-keypair:0xB17Ea8d34078424B9d7D126E444d5F2C3CC5c81E",
    "chain": "polygon"
  },
  "approvals": {
    "pending": [
      {
        "signer": "evm-keypair:0xB17Ea8d34078424B9d7D126E444d5F2C3CC5c81E",
        "message": "Hello world!"
      }
    ],
    "submitted": []
  },
  "createdAt": "2024-01-01T00:00:00Z"
}

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>

signatureId

string

required

Response

200

application/json

The signature has been successfully retrieved.

Complete signature response including status, signing requirements, and wallet type specific data

string

required

Unique identifier for the signature

type

enum<string>

required

The type of signature

Available options:

evm-message,

solana-message,

evm-typed-data,

aptos-message,

cardano-message,

sui-message

status

enum<string>

required

Current status of the signature

Available options:

awaiting-approval,

pending,

failed,

success

params

object

required

Type-specific signature parameters

params.message

string

required

The message in plain text to sign

params.chain

enum<string>

required

The chain on which the signature will be submitted

Available options:

arbitrum-sepolia,

avalanche-fuji,

curtis,

barret-testnet,

base-goerli,

base-sepolia,

bsc-testnet,

chiliz-spicy-testnet,

ethereum-goerli,

ethereum-sepolia,

hypersonic-testnet,

lightlink-pegasus,

optimism-goerli,

optimism-sepolia,

polygon-amoy,

polygon-mumbai,

crossmint-private-testnet-ethereum,

crossmint-private-testnet-polygon,

rari-testnet,

scroll-sepolia,

sei-atlantic-2-testnet,

shape-sepolia,

skale-nebula-testnet,

soneium-minato-testnet,

space-testnet,

story-testnet,

verify-testnet,

viction-testnet,

xai-sepolia-testnet,

zkatana,

zkyoto,

zora-goerli,

zora-sepolia,

mode-sepolia,

zenchain-testnet,

ethereum,

polygon,

bsc,

optimism,

arbitrum,

base,

zora,

arbitrumnova,

astar-zkevm,

apechain,

apex,

boss,

lightlink,

skale-nebula,

sei-pacific-1,

chiliz,

avalanche,

xai,

shape,

rari,

scroll,

viction,

mode,

space,

soneium,

story

params.signer

string

The locator for the signer who will submit this signature. Defaults to the wallet's admin signer.

Example:

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

createdAt

number

required

ISO timestamp when the signature was created

Example:

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

approvals

object

Complete approval data including requirements, pending and submitted signatures

approvals.pending

object[]

required

List of pending signatures

approvals.submitted

object[]

required

Record of all submitted signatures

approvals.submitted.signature

string

required

The cryptographic signature

approvals.submitted.submittedAt

number

required

When the signature was submitted

Example:

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

approvals.submitted.signer

string

required

The locator of the signer who submitted this signature

Example:

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

approvals.submitted.message

string

required

The message that was signed

approvals.submitted.metadata

object

Additional metadata about the signature submission

approvals.required

number

Number of required approvals for the transaction

completedAt

number

ISO timestamp when the transaction reached finality

Example:

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

error

any

Error message if the signature fails

outputSignature

string

The wallet's output signature of the request

Was this page helpful?

Get All Signatures Approve Signature

curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/wallets/{walletLocator}/signatures/{signatureId} \
  --header 'X-API-KEY: <x-api-key>'

{
  "id": "tx-b984491a-5785-43c0-8811-45d46fe6e520",
  "walletType": "evm-smart-wallet",
  "type": "evm-message",
  "status": "awaiting-approval",
  "params": {
    "message": "Hello, world!",
    "signer": "evm-keypair:0xB17Ea8d34078424B9d7D126E444d5F2C3CC5c81E",
    "chain": "polygon"
  },
  "approvals": {
    "pending": [
      {
        "signer": "evm-keypair:0xB17Ea8d34078424B9d7D126E444d5F2C3CC5c81E",
        "message": "Hello world!"
      }
    ],
    "submitted": []
  },
  "createdAt": "2024-01-01T00:00:00Z"
}

API Reference

Wallets

NFTs

IP

NFT Collections

NFT Templates

Verifiable Credentials

Verifiable Credential Types

Headless Checkout

Action Status

Admin

Subscriptions

Headers

Path Parameters

Response