Skip to main content
PATCH
/
v0
/
user
/
me
/
username
Update Username
curl --request PATCH \
  --url https://api.sumvin.com/v0/user/me/username \
  --header 'Content-Type: application/json' \
  --header 'x-sumvin-pat: <api-key>' \
  --data '
{
  "username": "john_doe"
}
'
{
  "_links": {
    "kyc-status": {
      "href": "/v0/kyc/status"
    },
    "self": {
      "href": "/v0/user/me"
    },
    "wallets": {
      "href": "/v0/wallets"
    }
  },
  "user": {
    "email": "user@example.com",
    "id": "usr_abc123"
  },
  "wallets": [
    {
      "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD78",
      "chain_id": 1329,
      "is_eoa": true,
      "is_primary": true
    }
  ]
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Body

application/json
​
username
string
required

New username. 3-20 chars, alphanumeric + underscores.

Required string length: 3 - 20
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,18}[a-zA-Z0-9]$
Example:

"john_doe"

Response

Username updated successfully

​
_links
UserLinks · object
required

HAL-style hypermedia links for navigation.

​
user
UserData · object
required

User profile.

​
wallets
WalletDataBase · object[] | null

User's wallets. Only included when expand=wallets is specified.

​
status_history
UserStatusData · object[] | null

Full audit trail of status changes. Only included when expand=status_history is specified.