External Accounts

Get customer external account by ID

Changed on Oct 2, 2026

Retrieve a customer external account by its system-generated ID

get/customers/external-accounts/{externalAccountId}

Request

Base URL
https://api.lightspark.com/grid/2025-10-13
URL
https://api.lightspark.com/grid/2025-10-13/customers/external-accounts/{externalAccountId}
Auth
HTTP basic

Response

Successful operation

idstring required

The system generated identifier of this account

customerIdstring

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

Status of an external account.

PENDING_OWNERSHIP_VERIFICATION: the wallet's ownership must be verified (e.g. under the EU Travel Rule) before unrestricted use; transfers below regulatory thresholds are still allowed. UNVERIFIED: the most recent verification attempt failed; start a new challenge to retry. Successful verification moves the account to ACTIVE.

platformAccountIdstring

Optional platform-specific identifier for this account

ownershipType'FIRST_PARTY' | 'THIRD_PARTY'

Whether the external account belongs to the customer themselves (FIRST_PARTY) or to someone else (THIRD_PARTY). Required when creating self-custody crypto wallet external accounts on platforms subject to counterparty requirements — for example, under the EU Travel Rule or similar requirements in other regions; recommended for all other accounts, where providing it can unlock additional capabilities and smoother compliance handling.

currencystring required

The ISO 4217 currency code

defaultUmaDepositAccountboolean

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.

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

Status	Description
MATCHED	The beneficiary name is an exact match
PARTIAL_MATCH	The beneficiary name is a fuzzy match
NOT_MATCHED	The beneficiary name does not match
UNSUPPORTED	The payment rail does not support name verification
CHECKED_BY_RECEIVING_FI	Verification is deferred to the receiving financial institution (e.g. ACH)
PENDING	Verification is still in progress

Example response

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

Changes

Oct 2, 2026dfe5a02f2fee Revision changes
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  added to the / response property oneOf list for the response status
- breaking
  removed the required property /////////// from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  added the new ACCOUNT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new ACH_SAME_DAY enum value to the ///////// response property for the response status
- warning
  added the new AUTH_METHOD_NOT_FOUND enum value to the response property for the response status
- warning
  added the new CUSTOMER_NOT_FOUND enum value to the response property for the response status
- warning
  added the new DOCUMENT_HOLDER_NOT_FOUND enum value to the response property for the response status
- warning
  added the new MOBILE_MONEY enum value to the ///////// response property for the response status
- warning
  added the new NEFT enum value to the ///////// response property for the response status
- warning
  added the new NOT_FOUND enum value to the response property for the response status
- warning
  added the new PAYMENT_DOCUMENT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new PAYMENT_URL_NOT_FOUND enum value to the response property for the response status
- warning
  added the new PENDING_OWNERSHIP_VERIFICATION enum value to the / response property for the response status
- warning
  added the new PLATFORM_NOT_FOUND enum value to the response property for the response status
- warning
  added the new REQUEST_NOT_FOUND enum value to the response property for the response status
- warning
  added the new RTGS enum value to the ///////// response property for the response status
- warning
  added the new SESSION_NOT_FOUND enum value to the response property for the response status
- warning
  added the new STABLECOIN_EXTERNAL_ACCOUNT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new STABLECOIN_NOT_FOUND enum value to the response property for the response status
- warning
  added the new STABLECOIN_OPERATION_NOT_FOUND enum value to the response property for the response status
- warning
  added the new STABLECOIN_PROVIDER_ACCOUNT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new UNVERIFIED enum value to the / response property for the response status
- warning
  added the new VERIFICATION_NOT_FOUND enum value to the response property for the response status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property / to the response with the status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  added subschema #3 to the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  removed subschema #1 subschema #3 from the // response property allOf list for the response status
- info
  the response property /////////// became required for the status
- info
  the response property /////////// became required for the status
- info
  added PLASMA_WALLET ARBITRUM_WALLET CNY_ACCOUNT ILS_ACCOUNT TRY_ACCOUNT discriminator mapping keys to the / response property for the response status
- info
  added the required property /////////// to the response with the status
- info
  added the required property /////////// to the response with the status
- info
  added the required property /////////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
May 28, 2026d0bce562bffd Revision changes
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  the response property /////////// became optional for the status
- breaking
  added to the / response property oneOf list for the response status
- breaking
  removed the required property /////////// from the response with the status
- breaking
  removed the required property /////////// from the response with the status
- breaking
  removed the required property /////////// from the response with the status
- breaking
  removed the required property /////////// from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new CC enum value to the ////// response property for the response status
- warning
  added the new CE enum value to the ////// response property for the response status
- warning
  added the new MOBILE_MONEY enum value to the ///////// response property for the response status
- warning
  added the new NIT enum value to the ////// response property for the response status
- warning
  added the new PP enum value to the ////// response property for the response status
- warning
  added the new REQUEST_ID_MISSING enum value to the response property for the response status
- warning
  added the new TI enum value to the ////// response property for the response status
- warning
  added the new UMA_NOT_FOUND enum value to the response property for the response status
- warning
  added the new WALLET_SIGNATURE_BODY_MISMATCH enum value to the response property for the response status
- warning
  added the new WALLET_SIGNATURE_INVALID enum value to the response property for the response status
- warning
  added the new WALLET_SIGNATURE_MALFORMED enum value to the response property for the response status
- warning
  added the new WALLET_SIGNATURE_MISSING enum value to the response property for the response status
- info
  added the optional property /////////// to the response with the status
- info
  the response property ////// became required for the status
- info
  added SLV_ACCOUNT SWIFT_ACCOUNT discriminator mapping keys to the / response property for the response status
- info
  the /////////// response's property pattern was changed from ^[A-Z]{2}[0-9]{2}[A-Za-z0-9]{11,30}$ to ^EG[0-9]{27}$ for the status
- info
  the /////////// response's property pattern was changed from ^[A-Z]{2}[0-9]{2}[A-Za-z0-9]{11,30}$ to ^DK[0-9]{16}$ for the status
- info
  the /////////// response's property pattern was changed from ^[A-Z]{2}[0-9]{2}[A-Za-z0-9]{11,30}$ to ^PK[0-9]{2}[A-Z]{4}[0-9]{16}$ for the status

Operation history (3 revisions)

Get customer external account by ID

Request

Response 200OK

Example response

Changes

Response