Skip to main content
GET
Get the fields a currency needs
The fields depend on the currency: an IBAN for EUR, a routing and an account number for USD. Render the schema, then send the answers to add the account. When a field is marked refreshRequirementsOnChange, send the answers so far to the refresh call and render the fields again.

Bank accounts by API

The flow end to end, with the SDK.

Build a platform

Managing businesses, start to finish.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Query Parameters

currency
string
required

The payout currency. EUR and USD are supported.

Response

The fields.

The fields a bank account in this currency needs, as a form schema: one entry per account type (iban for EUR, aba for USD), each with its fields, their validation and whether changing one refreshes the rest.

quoteId
string
required

Pass back to requirements/refresh when a field marked refreshRequirementsOnChange changes.

requirements
object[]
required