For AI agents: the docs index is at https://sync.dev.aero.inc/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Aerosync APIAerosync API
GuidesAPI Reference
v1.0

Log InAerosync API
Guides
Log In
v1.0GuidesAPI Reference

Get Started

  • Welcome to Aerosync
  • Get Started
  • Integration Process
    • Integration Flow
    • Best Practices
    • Test Cases

Integrate the Widget

  • Bank Linking Widget
    • Web NPM SDK (v2.0+)
      • Mobile WebView
      • Release Notes
    • React Native SDK (v4.0+)
      • Release Notes
    • iOS SDK (v2.0+)
      • iOS SDK v1.2.1 (legacy)
      • Release Notes
    • Android SDK
    • Flutter SDK (v2.0+)
      • Flutter SDK v1.3.4 (legacy)
      • Release notes
    • CDN
  • MFA Challenge Widget
  • Reconnection Widget

Integrate the API

  • Postman Collection
  • Aeronetwork Users (Pay v2.0 API)
    • AeroNetwork Users (Pay v1.1 API)
  • Generate a Token
  • Bank Account Details
  • Account Holder Identity
    • Step 1 - Create Job to Retrieve Identity
    • Step 2 - Check the Identity Job Status
    • Step 3 - Handle MFA (if necessary)
    • Step 4 - Retrieve Identity Details
  • Balance Refresh
    • Step 1 - Create Job to retrieve Balance data
    • Step 2 - Check the Balance Refresh Job Status
    • Step 3 - Handle MFA (if necessary)
    • Step 4 - Retrieve Balance details
  • Transaction History
    • Step 1 - Create Job to Retrieve Transaction History
    • Step 2 - Check the Transaction History Job Status
    • Step 3 - Handle MFA (if necessary)
    • Step 4 - Retrieve Transaction History Details
  • Manual Bank Verification
  • Handle Webhooks
    • Subscription Management API
    • Events you can subscribe to
    • Example Payloads
    • Verifying signatures (HMAC-SHA256)
    • Best Practices + Troubleshooting
    • Changelog

Handle Errors

  • Error Glossary
    • Widget Errors
    • API Errors

RESOURCES

  • Launch Checklist
  • Testing in the Sandbox Environment
    • Test the Bank Linking Widget
    • Test the MFA Challenge Widget
    • Test the API
    • Test Manual Bank Linking
  • Oauth Connections
  • Widget Customizations
  • Assets
Powered by 

API Integration Guides

Overview

Use the API integration guides to help expedite the development process

  • Generate a Token
  • Identity Job Workflow
  • Balance Refresh Job Workflow
  • Transaction History Job Workflow

Updated almost 2 years ago


Welcome to Aerosync
Did this page help you?
    • Overview