Skip to main content
GET
/
agents
/
me
/
external-accounts
cURL
curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/external-accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

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.

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.

Query Parameters

​
currency
string

Filter by currency code

​
limit
integer
default:20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100
​
cursor
string

Cursor for pagination (returned from previous request)

Response

Successful operation

​
data
object[]
required

List of external accounts matching the filter criteria

​
hasMore
boolean
required

Indicates if more results are available beyond this page

​
nextCursor
string

Cursor to retrieve the next page of results (only present if hasMore is true)

​
totalCount
integer

Total number of external accounts matching the criteria (excluding pagination)