/api/qmail/local/identity/get

GET

Extended local identity info. Returns the same fields as whoami plus a computed display_name and an address field that always has a value (a placeholder when no identity is registered).

Description

Use identity/get when you want a single value to render in the UI even before the user has imported an identity coin. The address field is always present (placeholder @unknown.unknown.kilo when not registered) and display_name falls back to SN#<serial> if first/last names are blank.

Parameters

None.

Response

Registered

{
  "command": "identity",
  "success": true,
  "registered": true,
  "address": "JANE.SMITH.kilo@8189",
  "serial_number": 8189,
  "denomination": 1,
  "display_name": "Jane Smith",
  "first_name": "Jane",
  "last_name": "Smith",
  "description": "",
  "class_name": "kilo",
  "class": "kilo",
  "beacon_raida": 11
}

Not registered

{
  "command": "identity",
  "success": true,
  "registered": false,
  "address": "@unknown.unknown.kilo",
  "message": "No identity coin registered. Place a coin in the Mail wallet."
}

Response Fields

FieldTypeDescription
registeredboolWhether an identity coin is currently loaded.
addressstringThe QMail email address (or placeholder when unregistered).
display_namestring"First Last" if names are present; otherwise SN#<serial>.
Other fields match the whoami response.

Errors

None — always returns 200.

Example

curl "http://localhost:8081/api/qmail/local/identity/get"

Related Endpoints