Axiym

Add a wallet address

Registers an external wallet in your organization's address book for whitelisting.

The entry starts in PENDING_REVIEW while Axiym performs due diligence and compliance checks. Once approved, its status becomes ACTIVE and it can fund deposits and receive withdrawals. The destination.activated webhook reports activation.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid
Idempotency-Key*string

A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

Registers an external wallet for whitelisting in your address book. The entry starts in PENDING_REVIEW while Axiym performs due diligence and compliance checks. It can fund deposits and receive withdrawals once ACTIVE.

currency*Currency

Currency associated with the external wallet.

walletAddress*string

Wallet address to register as an external account.

network*Network

Network of the wallet address.

Allowed values

  • "TRON"
  • "AVALANCHE"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json