Atomic Financial API
Number of APIs: 15
Documentation for the API surface of the Atomic Financial Public API.
Qodex Workspace
Structure
This Workspaces is grouped into folders. Each folder contains related functionality, which you can use to explore areas of the API:
- creating an access token
- using our company search to create a typeahead experience
- userlink or employerlink data integration
- continuous access via linked accounts
Each folder will have information in the documentation page of the folder detailing what is possible with the Requests in that folder.
There are many requests which take advantage both collection level and environment level variable. Some even have tests which will grab data from a response and store them in the appropriate variable for reuse. The environment variables are limited to data which will be environment specific; urls, api keys and secrets, tokens, etc.
We have provided both a Sandbox and Production environment which contain all variables we have used to create the Workspace.
Getting Started
- Get your API key and secret for your environment from the [Atomic Console](https://console.atomicfi.com).
- Store these values in the appropriate environment variables for creating an access token and any API requests which can be made using the API key and secret pair as opposed to the publicToken.
- Run the Create Access Token Request to populate the
publicToken
variable in order to set this value for future calls to the API.
More information
You can find more detailed information on the [Atomic Financial Docs site](https://docs.atomicfi.com).
Please leave comments here in the Workspace if you have any questions or concerns.
-
UserLink-Verify - Deposit Accounts - Deposit Accounts GET {{apiUrl}}/deposit-accounts/:identifier
-
Continuous Access and Monitoring-Linked Accounts - Create a Transact URL - Verify Linked Account POST {{apiUrl}}/access-token
-
UserLink-Task - Generate File URL GET {{apiUrl}}/task/:taskId/file/:fileId/generate-url
-
UserLink-Verify - Income - Income GET {{apiUrl}}/income/:identifier
-
UserLink-Verify - Statements - Statements GET {{apiUrl}}/statements/:identifier
-
UserLink-Verify - Taxes - Taxes GET {{apiUrl}}/taxes/:identifier
-
UserLink-Verify - Timesheets - Timesheets GET {{apiUrl}}/timesheets/:identifier
-
Continuous Access and Monitoring-Linked Accounts - List Linked Accounts GET {{apiUrl}}/linked-account/list/:identifier
-
Continuous Access and Monitoring-Linked Accounts - Resync data using Linked Account POST {{apiUrl}}/task-workflow/from-linked-account
-
Access Token - Create a Transact URL - Verify POST {{apiUrl}}/access-token