Skip to main content
POST
/
addresses
/
crypto
/
selfhosted
Register a self-hosted wallet address
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/addresses/crypto/selfhosted \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "address": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "signature": "<string>",
  "name": "<string>"
}
'
{
  "address": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "disabled": true,
  "id": "<string>",
  "signature": "<string>",
  "name": "<string>"
}

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring a signature is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner

Body

application/json; charset=utf-8

The self-hosted wallet registration request

Self-hosted wallet registration request

Proof of wallet ownership to register a self-hosted wallet for Travel Rule compliance

address
string
required

The address of the wallet

blockchain
enum<string>
required

Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
customer_id
string<uuid>
required

The customer ID

message
string
required

The message that was signed

signature
string
required

The signature of the message

name
string

Optional display name for this wallet address

Response

POST Self-Hosted Wallet Succeeded

Self-Hosted Wallet Response

Response containing self-hosted wallet details

address
string
required

The address that was proven

created_at
string<date-time>
required

When the wallet was registered

customer_id
string
required

The customer ID

disabled
boolean
required

Whether the address is disabled

id
string
required

The ID of the self-hosted wallet

signature
string
required

The signature that was submitted

name
string

Optional display name for this wallet address