Connection Flow
Understanding the connection lifecycle is essential for building a smooth user experience.
Overview
A connection represents a linked bank account. The flow to create one involves your backend, frontend widget, and Araucaria's servers working together.
sequenceDiagram
participant U as User
participant F as Your Frontend
participant B as Your Backend
participant A as Araucaria API
participant Bank as Bank
U->>F: Click "Connect Bank"
F->>B: Request widget token
B->>A: POST /v1/connections
A-->>B: { connectionId, widgetToken }
B-->>F: { connectionId, widgetToken }
F->>F: Open Araucaria Widget
U->>F: Select bank & enter credentials
F->>A: Submit credentials
A->>Bank: Validate credentials
Bank-->>A: Success
A-->>F: Connection ACTIVE
F->>U: Show success
A->>B: Webhook: connection.active
B->>B: Process new connection
Step-by-step Flow
- Create connection - Your backend calls POST /connections to get a widget token
- Open widget - Your frontend initializes the widget with the token
- User authenticates - User selects their bank and enters credentials
- Credentials verified - Araucaria validates with the bank
- Webhook notification - Araucaria sends a webhook to your backend when the connection is active