Retrieve account information

Retrieve the account information

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve details for an account or subaccount, including display name, status, country, and configuration.

Example Request

curl https://api.neutron.me/api/v2/account/YOUR_ACCOUNT_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Example Response

{
  "data": {
    "id": "ne01-abc123def456",
    "displayName": "My Company",
    "accountStatus": "active",
    "autoUserConfirm": false,
    "countryCode": "CA",
    "timezone": "America/Toronto",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T08:30:00.000Z"
  }
}

Response Fields

FieldTypeDescription
idstringUnique account identifier (e.g., ne01-...)
parentIdstringPresent if this is a subaccount — the parent account's ID
extIdstringExternal reference ID for subaccounts (set by parent)
displayNamestringAccount display name
accountStatusstringCurrent status (e.g., active)
autoUserConfirmbooleanIf true, transactions skip the manual confirm step
countryCodestringAccount's country code (e.g., CA, VN)
timezonestringAccount timezone
createdAtstringAccount creation timestamp
updatedAtstringLast update timestamp

Access Control

  • Works for both accounts and subaccounts
  • Subaccount info can be retrieved by the subaccount itself or its parent account
  • Requesting another account's info returns 401 Unauthorized

Subaccounts

If the account has a parentId, it's a subaccount. Subaccounts are useful for:

  • Marketplaces — each seller gets a subaccount
  • Platforms — each user gets isolated wallets
  • Multi-entity businesses — separate accounting per entity

The extId field lets you map subaccounts to your own system's user/entity IDs.

Path Params
string
required

The unique identifier of the account to retrieve

Responses

404

Not Found

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json