Version 2.4.8 · latest

Current user me

The signed-in user views or edits their own profile and real-name verification.

Pick an endpoint to see its example call on the right.

User accountsAuthentication: User4 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/meGet current user

Authentication: User

PUT/api/v2/meUpdate profile

Authentication: User

Request body application/json

FieldTypeDescription
emailstring Email
email_codestring Code sent to the new email (POST /verify-codes, purpose=bind); required when changing the email
login_ip_allowstring[] Login IP allowlist (IPs or CIDRs); empty means no restriction
login_verifyLoginVerify Second-factor login: none means not required; email / sms also require an email/SMS code at login (the platform must allow it and the address must be bound)
Values ["none","email","sms"]
nicknamestring Nickname; empty when not set (the UI shows the username)
passwordstring Current login password; changing the email, phone, login IP allowlist or second-factor login needs this or totp_code.
phonestring Phone number
phone_codestring Code sent to the new phone number (POST /verify-codes, purpose=bind); required when changing the phone number
totp_codestring Current 6-digit TOTP code; the account must have TOTP enabled.
POST/api/v2/me/certificationSubmit real-name verification

Authentication: User

Request body application/json

FieldTypeDescription
id_numberRequiredstring Masked ID number
real_nameRequiredstring Masked real name

Current user object

FieldTypeDescription
avatar_verinteger Avatar version, increases on every upload; empty when there is no avatar
balance_centsinteger Account balance in cents, same as balance_cents of GET /users/{user_id}/account (0 when there is no account). Only present in the GET /users list, not in single-user responses
read-only
certifiedboolean Whether real-name verification has passed
client_ipstring Source IP of this request, derived the same way as the login IP allowlist check (what the allowlist compares is what is shown). Only present in GET /me and PUT /me
read-only
created_atstring Created at
read-only
currencyCurrencyBrief Account currency (ISO 4217) and symbol; balance, recharges and orders use it, and the panel formats amounts with it; the new-user default when there is no account yet
read-only
delegated_sessionboolean Whether the current session was issued by superadmin sign-in or switch-to-user (if so, password, email, phone, login allowlist, login verification and real-name are read-only). Only present in GET /me and PUT /me
read-only
emailstring Email
email_codestring Code sent to the new email (POST /verify-codes, purpose=bind); required when changing the email
enabledboolean Whether enabled
idinteger Record ID
read-only
id_numberstring Masked ID number
ip_site_newboolean The user has an in-use (not expired) package that opens IP sites, so they can create IP sites, pick new IPs, issue paid ZeroSSL (zerossl_api) certificates and set API keys on ZeroSSL accounts. Only present in GET /me; always true for admins
read-only
ip_site_onboolean ip_site_new is true, or the user already owns an IP site, an IP certificate (all SANs are IPs) or a ZeroSSL account with an API key (free ZeroSSL accounts do not count), so IP site menus and tabs are shown and existing data can be viewed, edited and deleted. Only present in GET /me; always true for admins
read-only
login_ip_allowstring[] Login IP allowlist (IPs or CIDRs); empty means no restriction
login_verifyLoginVerify Second-factor login: none means not required; email / sms also require an email/SMS code at login (the platform must allow it and the address must be bound)
Values ["none","email","sms"]
nicknamestring Nickname; empty when not set (the UI shows the username)
passwordstring Current login password; changing the email, phone, login IP allowlist or second-factor login needs this or totp_code.
phonestring Phone number
phone_codestring Code sent to the new phone number (POST /verify-codes, purpose=bind); required when changing the phone number
providerstring Real-name verification provider
real_namestring Masked real name
reasonstring Reason for failure
rolestring Account role: admin or tenant
Values ["admin","tenant"]
statusstring Verification status: none, pending, verified or failed
Values ["none","pending","verified","failed"]
totp_codestring Current 6-digit TOTP code; the account must have TOTP enabled.
totp_enabledboolean Whether TOTP is enabled
totp_recovery_leftinteger Number of unused TOTP recovery codes. Only present in GET /me and PUT /me when TOTP is enabled
read-only
updated_atstring Updated at
read-only
urlstring Verification URL the user must visit while pending (returned only on submission)
usernamestring Username

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command