Skip to main content
POST
Whitelist an external wallet

Path Parameters

account-id
string<uuid>
required

Body

application/json
address
string
required

The wallet's EVM address, in any letter case

Example:

"0xdDa4775Ed1d0c831B006FD4061Edb1b30693a44c"

challenge
string
required

The challenge issued for this account and wallet, unchanged

Example:

"Crown: whitelist wallet 0xdda4775ed1d0c831b006fd4061edb1b30693a44c for account 019712cf-c86d-703f-85b8-bdaa4fc8d254. Expires at 2024-01-15T10:45:00Z."

signature
string
required

The wallet's personal_sign (EIP-191) signature of the challenge, 65 bytes as 0x-prefixed hex. A last byte of 0 or 1, or 27 or 28, is accepted

Pattern: ^0x[0-9a-fA-F]{130}$
Example:

"0x055b70e307b8ebbba01105a026164f5a8526af8ddf7149e3184d1d7e0bee4279377d982f2592028cdcea412105aece8b41529aac93e1c29545b9286d6c0071f41b"

capabilities
enum<string>[]

What the wallet is for. A wallet with rewards earns the account's rewards, receives FX payouts too, and belongs to that account alone. A wallet with fx alone only receives FX payouts, and several accounts can have the same one. Omitted, the wallet does both

Minimum array length: 1
Available options:
fx,
rewards
Example:
custody-type
enum<string> | null

Self-custody or exchange custody. Required when capabilities is fx alone

Available options:
self,
exchange
custody-country
string | null

Custodian country, ISO-3. Required when capabilities is fx alone

Example:

"BRA"

custodian-name
string | null

Custodian/exchange name. Required with exchange custody when capabilities is fx alone, and not accepted with self custody there

owner-type
enum<string> | null

Whether the account holder owns the wallet or someone else does. Required when capabilities is fx alone. A wallet with rewards belongs to the holder, so it accepts account-holder only

Available options:
account-holder,
third-party
Example:

"third-party"

owner-name
string | null

Legal name of the wallet's owner. Required with owner-type third-party, and not accepted otherwise

Minimum string length: 1
Example:

"Acme Ltd"

Response

Wallet whitelisted

external-wallet
object
required