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.
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.
/api/v2/meGet current user
Authentication: User
/api/v2/meUpdate profile
Authentication: User
Request body application/json
| Field | Type | Description |
|---|---|---|
email | string | |
email_code | string | Code sent to the new email (POST /verify-codes, purpose=bind); required when changing the email |
login_ip_allow | string[] | Login IP allowlist (IPs or CIDRs); empty means no restriction |
login_verify | LoginVerify | 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) |
nickname | string | Nickname; empty when not set (the UI shows the username) |
password | string | Current login password; changing the email, phone, login IP allowlist or second-factor login needs this or totp_code. |
phone | string | Phone number |
phone_code | string | Code sent to the new phone number (POST /verify-codes, purpose=bind); required when changing the phone number |
totp_code | string | Current 6-digit TOTP code; the account must have TOTP enabled. |
/api/v2/me/certificationGet real-name verification status
Authentication: User
/api/v2/me/certificationSubmit real-name verification
Authentication: User
Request body application/json
| Field | Type | Description |
|---|---|---|
id_numberRequired | string | Masked ID number |
real_nameRequired | string | Masked real name |
Current user object
| Field | Type | Description |
|---|---|---|
avatar_ver | integer | Avatar version, increases on every upload; empty when there is no avatar |
balance_cents | integer | 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 |
certified | boolean | Whether real-name verification has passed |
client_ip | string | 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 |
created_at | string | Created at |
currency | CurrencyBrief | 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 |
delegated_session | boolean | 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 |
email | string | |
email_code | string | Code sent to the new email (POST /verify-codes, purpose=bind); required when changing the email |
enabled | boolean | Whether enabled |
id | integer | Record ID |
id_number | string | Masked ID number |
ip_site_new | boolean | 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 |
ip_site_on | boolean | 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 |
login_ip_allow | string[] | Login IP allowlist (IPs or CIDRs); empty means no restriction |
login_verify | LoginVerify | 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) |
nickname | string | Nickname; empty when not set (the UI shows the username) |
password | string | Current login password; changing the email, phone, login IP allowlist or second-factor login needs this or totp_code. |
phone | string | Phone number |
phone_code | string | Code sent to the new phone number (POST /verify-codes, purpose=bind); required when changing the phone number |
provider | string | Real-name verification provider |
real_name | string | Masked real name |
reason | string | Reason for failure |
role | string | Account role: admin or tenant |
status | string | Verification status: none, pending, verified or failed |
totp_code | string | Current 6-digit TOTP code; the account must have TOTP enabled. |
totp_enabled | boolean | Whether TOTP is enabled |
totp_recovery_left | integer | Number of unused TOTP recovery codes. Only present in GET /me and PUT /me when TOTP is enabled |
updated_at | string | Updated at |
url | string | Verification URL the user must visit while pending (returned only on submission) |
username | string | 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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}