Get account information

GET /api/user

Fetch the account for a wallet address: available and pending USD balances, whether the account is disabled, the default account metadata, and the per-account configuration (spend limits, retry policy, circuit breaker, and IP/domain whitelists). This endpoint requires no authentication.

Parameters

Name	In	Type	Required	Description
address	query	string	yes	The wallet address the account was created for.

Responses

Status	Description
200	The account details.
400	Invalid request. Plausible codes: VALIDATION_004 (the address parameter is missing or empty).
404	No account exists for this address. Plausible codes: USER_001.
500	Server error. Plausible codes: SYSTEM_001.

200 response

{
  "success": true,
  "data": {
    "userId": "68c275846a6ba1c9a2198a8c",
    "address": "0xa7a833e6641d7901f30ead6f27d4ee2c9bb670a7",
    "availableBalance": 24.5,
    "pendingBalance": 1.2,
    "disabled": false,
    "defaultPhotonAccount": null,
    "userConfig": {
      "perTxLimit": 5,
      "dailyLimit": 100,
      "dailyAmountConsumed": 12.75,
      "dailyAmountUpdatedAt": "2026-07-29T00:00:00.000Z",
      "disabledChainIds": [],
      "maxRetries": 3,
      "circuitBreakerEnabled": true,
      "failureCountStreakLimit": 10,
      "failureCountStreak": 0,
      "ipWhitelist": [],
      "domainWhitelist": []
    }
  },
  "timestamp": "2026-07-29T12:34:56.789Z"
}

400 response

{
  "success": false,
  "error": {
    "code": "VALIDATION_004",
    "message": "`address` is required",
    "category": "VALIDATION",
    "traceId": "6f2c1e0a-8b4d-4c1e-9f3a-2d5b7c8e9a01"
  },
  "timestamp": "2026-07-29T12:34:56.789Z"
}

404 response

{
  "success": false,
  "error": {
    "code": "USER_001",
    "message": "User not found",
    "category": "USER",
    "traceId": "6f2c1e0a-8b4d-4c1e-9f3a-2d5b7c8e9a01"
  },
  "timestamp": "2026-07-29T12:34:56.789Z"
}

500 response

{
  "success": false,
  "error": {
    "code": "SYSTEM_001",
    "message": "Database operation failed",
    "category": "SYSTEM",
    "traceId": "6f2c1e0a-8b4d-4c1e-9f3a-2d5b7c8e9a01"
  },
  "timestamp": "2026-07-29T12:34:56.789Z"
}