Connections

Import from Plaid

Imports a Connection from an existing Plaid record.

post/v1/profiles/{profileId}/connections/import/plaid

Request

  • Base URL: https://api.quiltt.io
  • URL: https://api.quiltt.io/v1/profiles/{profileId}/connections/import/plaid
  • Auth: HTTP bearer

Path parameters

profileIdstring global_id-v1 required

The ID of the Profile.

Example:p_1hyoxpVVFib1HngGwKAzIr

Request body

accessTokenstring required

The token to import from Plaid.

mode'REALTIME' | 'BACKGROUND'

The mode of the import operation. Use BACKGROUND when importing batches of Connections, or when you don't need immediate access to synced data.

  • REALTIME: Syncing process will be kicked off immediately.
  • BACKGROUND: Syncing will occur shortly after import, with a slight delay.
externallyManagedboolean

Specifies whether this Connection is managed by an external system.

When a Connection is imported as externally-managed, Quiltt will sync it, but disconnecting it will not revoke access from the upstream provider.

migrateWebhookboolean

Whether to migrate the webhook registered with Plaid to be consumed by Quiltt.

When set to false, Quiltt will preserve the existing webhook registered with Plaid and the Connection will sync less frequently.

createdAtstring date-time

The timestamp when the Plaid Item was created, in ISO 8601 format.

productsstring[]

The authorized Plaid products to sync on the Connection.

These products will be added to the products Quiltt can detect automatically. Note that balance, investments and liabilities are always detected automatically.

institutionIdstring

The Plaid Institution ID, to be supplied only if directed by Quiltt

Example request

{
  "accessToken": "access-sandbox-560d5d7e-b4c4-4b13-8e39-1cb9370051d3",
  "mode": "BACKGROUND",
  "externallyManaged": true,
  "createdAt": "2025-09-12T23:55:59Z",
  "products": [
    "auth",
    "transactions"
  ]
}

Response

Successfully imported

idstring global_id-v1 required

The ID of the Connection.

atstring date-time required

The UTC date and time of the most recently known state of the Connection.

For active Connections, this is when data was last successfully synced with the upstream provider. For disconnected Connections, this is the time of the disconnection from the upstream provider.

provider'AKOYA' | 'FINICITY' | 'MOCK' | 'MX' | 'PLAID' | 'DISCONNECTED' required

Represents the data provider for the Connection.

  • AKOYA - Akoya
  • FINICITY - Finicity
  • MOCK - Mock data
  • MX - MX
  • PLAID - Plaid
  • DISCONNECTED - Disconnected
featuresstring[] required

The products currently enabled on the Connection.

productsstring[] required

The products currently enabled on the Connection.

status'INITIALIZING' | 'SYNCING' | 'SYNCED' | 'ERROR_REPAIRABLE' | 'ERROR_SERVICE' | 'ERROR_PROVIDER' | 'ERROR_INSTITUTION' | 'DISCONNECTING' | 'DISCONNECTED' required

Represents the current state of a Connection.

See the Connection docs for help troubleshooting error statuses.

Note that this enum is extensible and new values may be added over time.

  • INITIALIZING - The Connection is being initialized and will begin syncing soon.
  • SYNCING - The Connection is currently syncing with the provider.
  • SYNCED - The Connection is synced and up to date with the provider.
  • ERROR_REPAIRABLE - The Connection must be re-authenticated to resume syncing. Quiltt will keep trying to sync this Connection until it is re-authenticated.
  • ERROR_SERVICE - Quiltt is experiencing an internal error attempting to sync this Connection. The Quiltt team has been notified and the Connection will be retried automatically once the issue is resolved.
  • ERROR_PROVIDER - The Connection provider is reporting an error with the Connection. Quiltt will keep trying to sync this Connection until the error is resolved.
  • ERROR_INSTITUTION - The Connection provider is reporting an error from the user's Institution. Quiltt will keep trying to sync this Connection until the error is resolved.
  • DISCONNECTING - The Connection is in the process of being disconnected from its provider.
  • DISCONNECTED - The Connection has been fully disconnected from the provider.

Accounts and associated data will remain on the Profile, but no new data will be synced until another Connection is established to the same Institution.

You can leverage the Connector Reconnect flow to prompt the user to re-establish the Connection.

metadataobject nullable required

Custom metadata about the Connection, stored in a 'key-value' format.

See the Custom Metadata guide for more information and examples.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
  "at": "2025-09-24T14:15:22Z",
  "provider": "MX",
  "status": "SYNCED",
  "metadata": {
    "hiddenFromUI": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.