v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Deposits

List UMA addresses

Retrieves a list of UMA addresses associated with your platform.

get/deposits/uma

Query parameters

participant_codestring

Filters for all addresses associated with a participant_code

page_sizenumber

Example:10

Limits the number of addresses returned in the response

offsetnumber

Skips over the specified number of addresses in the response

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of UMA addresses with optional filters: participant_code, page_size, offset.

totalnumber

Example response

{
  "message": [
    {
      "participant_code": "ABCDEF",
      "platform_code": "ABCDEF",
      "platform_uma_domain": "uma-server.zerohash.com",
      "username": "$username",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    }
  ],
  "total": 1
}