Ingest Data

Once a user has connected their account, you can ingest their data using Atomic’s API or webhooks. Webhooks are ideal for receiving real-time updates and staying current with changes to user accounts. Alternatively, you can retrieve data on demand using Atomic’s API endpoints. You’re free to use either method independently or combine both to keep your application in sync.

Ingest Data

This guide outlines what’s required to ingest data from Atomic. The data is collected through a consumer-permissioned connection to a company, meaning the user must first establish that connection before any data becomes available. For details on how to connect user accounts, see the Connecting User Accounts guide. Note that this is an asynchronous process—webhooks and SDK events will notify you when the data is ready.

Ingest Data via Webhooks

In order to receive data via webhooks. You will need to register a webhook through console in order to receive data from Atomic's system. View the guide on setting up webhooks for more detail.

For the Manage product, you should ensure you set up the task-status-updated and pay-link-accounts-updated webhooks, in addition to any others you find relevant.

Once the user successfully connects their account, Atomic will send the users data via webhook to the endpoint(s) that were registered in Step 1.

In order to determine when your user's accounts have been successfully connected, listen to the task-status-updated webhook. This webhook will not contain the user's account data, but will indicate when the user has successfully connected their account and made their data ready to retrieve. Possible fields for status include processing, completed, and failed.

A status of completed indicates that the user was successful in connecting their account and their data has been synced to Atomic's system. At this point you can query our API and get up-to-date data.

For more information on fields on the task-status-updated event, see the webhook reference .

In order to retrieve your user's account data, listen to the pay-link-accounts-updated webhook.

This webhook will contain the users account information, and will be sent whenever we detect changes to the user's account.

For detailed information on the structure of the pay-link-accounts-updated webhook, see the webhook reference .

Retrieve Data via API

In addtion to the data being available via webhooks, user data can also be retrieved via Atomic's API endpoints.

Atomic provides a comprehensive set of endpoints for multiple use cases, but almost all cases will use the GET /pay-link/accounts endpoint to retrieve data.

GET /pay-link/accounts lists all accounts a user has connected or attempted to connect in the past. It is the primary source for all data Atomic has gathered about an account.

For more information about the request and response schemas, as well as a list of all APIs available, please see the API Reference .