curl --request GET \
--url https://api.lightspark.com/grid/2025-10-13/agents/me/external-accounts/{externalAccountId} \
--header 'Authorization: Bearer <token>'{
"id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
"status": "ACTIVE",
"currency": "USD",
"accountInfo": {
"accountType": "BRL_ACCOUNT",
"pixKey": "user@example.com",
"pixKeyType": "CPF",
"taxId": "11111111111"
},
"customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
"platformAccountId": "acc_123456789",
"defaultUmaDepositAccount": false,
"beneficiaryVerificationStatus": "MATCHED",
"beneficiaryVerifiedData": {
"fullName": "John Doe"
}
}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.
curl --request GET \
--url https://api.lightspark.com/grid/2025-10-13/agents/me/external-accounts/{externalAccountId} \
--header 'Authorization: Bearer <token>'{
"id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
"status": "ACTIVE",
"currency": "USD",
"accountInfo": {
"accountType": "BRL_ACCOUNT",
"pixKey": "user@example.com",
"pixKeyType": "CPF",
"taxId": "11111111111"
},
"customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
"platformAccountId": "acc_123456789",
"defaultUmaDepositAccount": false,
"beneficiaryVerificationStatus": "MATCHED",
"beneficiaryVerifiedData": {
"fullName": "John Doe"
}
}Documentation Index
Fetch the complete documentation index at: https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
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.
System-generated unique external account identifier
Successful operation
The system generated identifier of this account
"ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
Status of the external account
PENDING, ACTIVE, UNDER_REVIEW, INACTIVE "ACTIVE"
The ISO 4217 currency code
"USD"
Show child attributes
{
"accountType": "BRL_ACCOUNT",
"pixKey": "user@example.com",
"pixKeyType": "CPF",
"taxId": "11111111111"
}
The customer this account is tied to, or null if the account is on behalf of the platform.
"Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7"
Optional platform-specific identifier for this account
"acc_123456789"
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.
false
The result of verifying the beneficiary name against the account holder name
MATCHED, PARTIAL_MATCH, NOT_MATCHED, UNSUPPORTED, CHECKED_BY_RECEIVING_FI, PENDING Verified beneficiary data returned by the payment rail, if available
Show child attributes
Was this page helpful?