Agent Tool Definitions
Use these tool definitions to connect an AI agent to Atomic's direct deposit switch. They cover finding the user's payroll account through CoAuth, finding their employer or payroll system, preparing Transact sessions with the amount the user confirmed, and checking switch results.
A tool definition tells the model what a function does, when to use it, and which inputs it accepts. Your backend implements that function and supplies the credentials, user context, destination account and identity details when the model calls it. For steps that need the user's interaction, the app opens the Transact SDK to handle payroll sign-in and the deposit change.
The tools.json download contains the five definitions used by the example app, each with a name, description, and JSON input schema. Register them with your agent framework and use the Switch Direct Deposit guide to follow how the backend handlers, app, and Atomic work together. The download contains definitions only; the guide links to the example's implementation.
curl -O https://docs.atomicfi.com/agent-tools/deposit/tools.jsonTools in this version
These summaries describe each tool's role. The download includes the full instructions for the model and each tool's input schema.
| Tool | What it does |
|---|---|
find_payroll_accounts | Looks the user up by identity in the payroll systems Atomic has CoAuth partnerships with, once they've asked to move their deposit. A user found there confirms the switch with a code instead of a password. |
search_companies | Searches for employers, payroll providers and gig platforms where a deposit switch is available. Can narrow to the employers on one payroll system or the franchisees under one brand. |
get_company_details | Says whether a switch is available right now, which payroll systems the company uses, whether sign-in differs per employer, and how much of the paycheck each payroll system can move. |
get_deposit_config | Checks the company, payroll system and confirmed amount, then creates a public token and a launch configuration deeplinked to the company's sign-in. The app displays a button to open Transact. |
check_events | Reads each deposit task's current status from stored webhooks, so the agent can report the switch with the task ID Transact returned. |
Implement each handler on your server using the example handlers and system prompt as references for API calls, response fields, and result handling. The example uses LangChain; adapt the definition fields to your framework's tool format when using another framework.
Your backend owns execution, credentials, user sessions, and event storage. Pass the user's identifier, destination account and identity details from your server's authenticated context and records. They are not tool inputs. Company and connector IDs returned by Atomic remain visible to the model.
For get_deposit_config, keep the public token and launch configuration in an artifact sent only to the app, and return only a notice to the model. The example's tool adapter shows how to separate that artifact from the result the model receives.
Versions
The tool set is versioned. formatVersion describes the file format, and version is the date the definitions last changed. We measure how agents use these tools, so names, inputs, and the number of tools can change between versions. Before you update, compare the version with the one you built against, and review the definitions, handlers, and system prompt together. The download notes describe the file format.
For subscription cancellation, see the PayLink tool definitions.