Retrieve an Account

Retrieves account information for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/accounts/{accountId} \
  --header 'Authorization: <authorization>'

{
  "message": "Account retrieved successfully",
  "status": 200,
  "data": {
    "account": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "balance_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "type": "checking",
      "currency": "USD",
      "display_name": "Business Account",
      "meta": {},
      "config": {
        "is_overdraftable": false,
        "overdraft_limit": 0
      },
      "created": 1693584000000,
      "updated": 1693584000000,
      "balance": {
        "overdraft_used": 0,
        "current": 1000.5,
        "available": 950.25
      }
    },
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "name": "Acme Corporation",
      "type": "business",
      "verification_status": "verified"
    },
    "account_details": [
      {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
        "account_number": "1234567890",
        "routing_number": "987654321",
        "description": "Primary account details",
        "issuer": {
          "name": "Example Bank",
          "code": "EXBNK",
          "address": "123 Banking St, Finance City",
          "meta": {}
        },
        "config": {
          "outflow_enabled": true,
          "inflow_enabled": true,
          "outflow_allowed_counterparties": [],
          "inflow_allowed_counterparties": []
        },
        "status": "active",
        "created": 1693584000000,
        "updated": 1693584000000
      }
    ],
    "pinned_status": {
      "is_pinned": true,
      "pinned_at": 1693584000000,
      "pinned_by_count": 1
    },
    "counterparties_summary": {
      "total_active": 3,
      "total_inactive": 1,
      "recent_activity": 3
    },
    "compliance_status": {
      "risk_level": "low",
      "sanctions_status": "clear",
      "monitoring_level": "standard",
      "last_reviewed": 1672531500000,
      "flags": []
    }
  }
}

GET

accounts

{accountId}

Retrieves account information for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/accounts/{accountId} \
  --header 'Authorization: <authorization>'

{
  "message": "Account retrieved successfully",
  "status": 200,
  "data": {
    "account": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "balance_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "type": "checking",
      "currency": "USD",
      "display_name": "Business Account",
      "meta": {},
      "config": {
        "is_overdraftable": false,
        "overdraft_limit": 0
      },
      "created": 1693584000000,
      "updated": 1693584000000,
      "balance": {
        "overdraft_used": 0,
        "current": 1000.5,
        "available": 950.25
      }
    },
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "name": "Acme Corporation",
      "type": "business",
      "verification_status": "verified"
    },
    "account_details": [
      {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
        "account_number": "1234567890",
        "routing_number": "987654321",
        "description": "Primary account details",
        "issuer": {
          "name": "Example Bank",
          "code": "EXBNK",
          "address": "123 Banking St, Finance City",
          "meta": {}
        },
        "config": {
          "outflow_enabled": true,
          "inflow_enabled": true,
          "outflow_allowed_counterparties": [],
          "inflow_allowed_counterparties": []
        },
        "status": "active",
        "created": 1693584000000,
        "updated": 1693584000000
      }
    ],
    "pinned_status": {
      "is_pinned": true,
      "pinned_at": 1693584000000,
      "pinned_by_count": 1
    },
    "counterparties_summary": {
      "total_active": 3,
      "total_inactive": 1,
      "recent_activity": 3
    },
    "compliance_status": {
      "risk_level": "low",
      "sanctions_status": "clear",
      "monitoring_level": "standard",
      "last_reviewed": 1672531500000,
      "flags": []
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Path Parameters

accountId

string

required

The unique identifier (ULID) of the account to retrieve

Response

Successful operation

message

string

required

A descriptive message indicating the result of the operation

status

string

required

The status of the API operation (successful, error, failed, pending)

data

object

required

The data returned from the operation

Show child attributes

data.account

object

required

Detailed information about the account

Show child attributes

data.account.id

string

required

Unique identifier for the account

data.account.entity_id

string

required

Identifier of the entity that owns the account

data.account.balance_id

string

required

Identifier for the balance record associated with this account

data.account.type

string

required

The type of account

data.account.currency

string

required

The currency code for the account

data.account.display_name

string

required

User-friendly name for the account

data.account.config

object

required

Configuration options for the account

Show child attributes

data.account.config.is_overdraftable

boolean

required

Whether the account can be overdrawn

data.account.config.overdraft_limit

number

required

Maximum amount the account can be overdrawn by

data.account.created

number

required

Timestamp when the account was created (in milliseconds since epoch)

data.account.updated

number

required

Timestamp when the account was last updated (in milliseconds since epoch)

data.account.balance

object

required

Current balance information for the account

Show child attributes

data.account.balance.overdraft_used

number

required

Amount of overdraft currently being used

data.account.balance.current

number

required

Current total balance including pending transactions

data.account.balance.available

number

required

Available balance that can be spent

data.account.meta

object

Additional metadata for the account

data.entity

object

required

Information about the entity that owns the account

Show child attributes

data.entity.id

string

required

Unique identifier for the entity

data.entity.name

string

required

Name of the entity

data.entity.type

string

required

Type of the entity

data.entity.verification_status

string

required

Verification status of the entity

data.account_details

object

required

List of account details associated with this account

Show child attributes

data.account_details.id

string

required

Unique identifier for the account details

data.account_details.entity_id

string

required

Identifier of the entity that owns the account

data.account_details.account_id

string

required

Identifier of the associated account

data.account_details.account_number

string

required

Account number for the bank account

data.account_details.routing_number

string

required

Routing number for the bank account

data.account_details.issuer

object

required

Information about the bank or financial institution that issued the account

Show child attributes

data.account_details.issuer.name

string

required

Name of the issuing bank or financial institution

data.account_details.issuer.code

string

required

Code or identifier for the issuing bank

data.account_details.issuer.address

string

Physical address of the issuing bank

data.account_details.issuer.meta

object

Additional metadata about the issuer

data.account_details.config

object

required

Configuration options for the account details

Show child attributes

data.account_details.config.outflow_enabled

boolean

required

Whether outflow (payments from this account) is enabled

data.account_details.config.inflow_enabled

boolean

required

Whether inflow (payments to this account) is enabled

data.account_details.config.outflow_allowed_counterparties

string[]

List of counterparties allowed for outflow payments

data.account_details.config.inflow_allowed_counterparties

string[]

List of counterparties allowed for inflow payments

data.account_details.status

string

required

Current status of the account details

data.account_details.created

number

required

Timestamp when the account details were created (in milliseconds since epoch)

data.account_details.updated

number

required

Timestamp when the account details were last updated (in milliseconds since epoch)

data.account_details.description

string

Description of the account details

data.pinned_status

object

Information about whether the account is pinned

Show child attributes

data.pinned_status.is_pinned

boolean

required

Whether the account is pinned

data.pinned_status.pinned_at

number

Timestamp when the account was pinned (in milliseconds since epoch)

data.pinned_status.pinned_by_count

number

Number of users who have pinned this account

data.counterparties_summary

object

Summary information about counterparties associated with this account

Show child attributes

data.counterparties_summary.total_active

number

required

Total number of active counterparties

data.counterparties_summary.total_inactive

number

required

Total number of inactive counterparties

data.counterparties_summary.recent_activity

number

required

Number of counterparties with recent activity

data.compliance_status

object

Compliance-related information for the account

Show child attributes

data.compliance_status.risk_level

string

required

Risk level associated with the account

data.compliance_status.sanctions_status

string

required

Status of sanctions checks

data.compliance_status.monitoring_level

string

required

Level of monitoring applied to the account

data.compliance_status.flags

string[]

required

List of compliance flags on the account

data.compliance_status.last_reviewed

number

Timestamp when the account was last reviewed for compliance (in milliseconds since epoch)

List Accounts Update an Account

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Retrieve an Account

Headers

Path Parameters

Response