v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Deposits

Update UMA address

Updates an UMA username for a given participant.

patch/deposits/uma

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.

Request body

participant_codestring required

The participant code to create an address for

previous_usernamestring required

The username displayed on the UMA address excluding the domain

new_usernamestring required

The username displayed on the UMA address excluding the domain

Example request

{
  "participant_code": "CUST01",
  "previous_username": "$john",
  "new_username": "$bob"
}

Response

Successfully updated UMA address. Returns the updated resource.