Skip to main content
POST
/
api
/
private
/
v2
/
wallet
/
address-book
/
Add Address Book Entry
curl --request POST \
  --url https://app.digitalsurge.com.au/api/private/v2/wallet/address-book/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset": "<string>",
  "address": "<string>",
  "label": "<string>"
}
'
{
  "id": 123,
  "asset": "<string>",
  "asset_name": "<string>",
  "address": "<string>",
  "label": "<string>",
  "confirmed": true,
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created": "2023-11-07T05:31:56Z",
  "last_used": "2023-11-07T05:31:56Z",
  "times_used": 123,
  "memo": "<string>",
  "enabled": true
}

Authorizations

​
Authorization
string
header
required

Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as Authorization: Bearer <your-api-key>.

Body

Serializer for creating and listing withdrawal address book entries. Accepts optional nested travel_rule data on creation.

​
asset
string
required
Minimum string length: 1
​
address
string
required
Required string length: 1 - 256
​
label
string
required

User-friendly label (e.g., 'My Ledger', 'Cold Storage')

Required string length: 1 - 200
​
memo
string

Tag/Memo for assets that require it (XRP, XLM, etc)

Maximum string length: 256
​
enabled
boolean

False = soft deleted

​
travel_rule
object

Write serializer for travel rule data submission.

Accepts raw enum values for write, validates conditional requirements. Used for both address book and deposit TR data submissions.

Response

201 - application/json

Serializer for creating and listing withdrawal address book entries. Accepts optional nested travel_rule data on creation.

​
id
integer
required
read-only
​
asset
string
required
​
asset_name
string
required
read-only
​
address
string
required
Maximum string length: 256
​
label
string
required

User-friendly label (e.g., 'My Ledger', 'Cold Storage')

Maximum string length: 200
​
confirmed
boolean
required
read-only

Email confirmation status

​
confirmed_at
string<date-time> | null
required
read-only
​
created
string<date-time>
required
read-only
​
last_used
string<date-time> | null
required
read-only

Last time used for a withdrawal

​
times_used
integer
required
read-only
​
memo
string

Tag/Memo for assets that require it (XRP, XLM, etc)

Maximum string length: 256
​
enabled
boolean

False = soft deleted