Get agent external account by ID

Retrieve an external account belonging to the authenticated agent’s customer. Returns 404 if the account exists but belongs to a different customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent’s policy.

GET /agents/me/external-accounts/{externalAccountId}

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/external-accounts/{externalAccountId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
  "status": "ACTIVE",
  "currency": "USD",
  "accountInfo": {
    "accountType": "AED_ACCOUNT",
    "iban": "AE070331234567890123456",
    "swiftCode": "EBILAEAD"
  },
  "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
  "platformAccountId": "acc_123456789",
  "defaultUmaDepositAccount": false,
  "beneficiaryVerifiedData": {
    "fullName": "John Doe"
  }
}

Authorizations

Authorization · string · header · required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Path Parameters

externalAccountId · string · required

System-generated unique external account identifier

Response

200

application/json

Successful operation

id · string · required

The system generated identifier of this account

Example:

"ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"

status · enum<string> · required

Status of the external account

Available options: PENDING, ACTIVE, UNDER_REVIEW, INACTIVE

Example:

"ACTIVE"

currency · string · required

The ISO 4217 currency code

Example:

"USD"

accountInfo · AED Account · object · required

AED Account

BDT Account

BRL Account

BWP Account

CAD Account

COP Account

DKK Account

EGP Account

EUR Account

GBP Account

GHS Account

GTQ Account

HKD Account

HTG Account

IDR Account

INR Account

JMD Account

KES Account

MWK Account

MXN Account

MYR Account

NGN Account

PHP Account

PKR Account

RWF Account

SGD Account

SLV Account

THB Account

TZS Account

UGX Account

USD Account

VND Account

XAF Account

XOF Account

ZAR Account

ZMW Account

SWIFT Account

Base Wallet

Ethereum L1 Wallet

Lightning

Polygon Wallet

Solana Wallet

Spark Wallet

Tron Wallet

Show child attributes

Example:

{
  "accountType": "AED_ACCOUNT",
  "iban": "AE070331234567890123456",
  "swiftCode": "EBILAEAD"
}

customerId · string

The customer this account is tied to, or null if the account is on behalf of the platform.

Example:

"Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7"

platformAccountId · string

Optional platform-specific identifier for this account

Example:

"acc_123456789"

defaultUmaDepositAccount · boolean

Whether this account is the default UMA deposit account for the customer. If true, incoming UMA payments to this customer's UMA address will be automatically deposited into this account instead of the primary internal account. False if not provided. Note that at most, one external account can be set as the default UMA deposit account for a customer. If there is no default UMA deposit account, incoming UMA payments will be deposited into the primary internal account for the customer.

Example:

false

beneficiaryVerificationStatus · enum<string>

The result of verifying the beneficiary name against the account holder name

Available options: MATCHED, PARTIAL_MATCH, NOT_MATCHED, UNSUPPORTED, CHECKED_BY_RECEIVING_FI, PENDING

beneficiaryVerifiedData · object

Verified beneficiary data returned by the payment rail, if available

Show child attributes