Skip to main content
POST
Add Address Book Entry

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