Add a Connection
POST/v2/admin/connections
Registers a new connection with a financial provider.
Asynchronous Processing: the
201response is returned before the credentials are validated with the provider. The connection is created withvalidated_atandvalidate_failed_atnull, and validation finishes in the background.
Validation cycle​
| State | validated_at | validate_failed_at |
|---|---|---|
| Validating | null | null |
| Validated | filled | null |
| Failed | null | filled |
When validation succeeds, enabled_at is also filled, even if the connection was created with enabled: false.
Webhook Events​
integration.connection.db.created: fired by this operation, with the connection not yet validated.integration.connection.db.updated: fired when validation finishes, whether it succeeds or fails. Read the outcome inobject.validated_atandobject.validate_failed_at: the failure does not appear inchanges.
Request​
Responses​
- 201
- 401
- 403
- 422
Connection created
Authentication failure. Invalid token
Permission failure. You do not have the required Scope for this call.
Invalid connection data