Skip to main content
POST
/
agents
/
me
/
external-accounts
cURL
curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/external-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "accountInfo": {
    "accountType": "USD_ACCOUNT",
    "accountNumber": "12345678901",
    "routingNumber": "123456789",
    "bankAccountType": "CHECKING",
    "bankName": "Chase Bank",
    "beneficiary": {
      "beneficiaryType": "INDIVIDUAL",
      "fullName": "John Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      }
    }
  }
}
'
{
  "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.

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.

Body

application/json
​
currency
string
required

The ISO 4217 currency code

Example:

"USD"

​
accountInfo
AED Account · object
required
Example:
{
  "accountType": "AED_ACCOUNT",
  "iban": "AE070331234567890123456",
  "swiftCode": "EBILAEAD"
}
​
customerId
string

The ID of the customer for whom to create the external account. If not provided, the external account will be created on behalf of the platform.

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

​
platformAccountId
string

Your platform's identifier for the account in your system. This can be used to reference the account by your own identifier.

Example:

"ext_acc_123456"

​
defaultUmaDepositAccount
boolean
default:false

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

Response

External account created successfully

​
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
BRL Account · object
required
Example:
{
  "accountType": "BRL_ACCOUNT",
  "pixKey": "user@example.com",
  "pixKeyType": "CPF",
  "taxId": "11111111111"
}
​
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