v3

latestOpenAPI 3.0.32026-07-31489099.0 KB

Financial Institutions

Register financial institution account via Plaid and return address ID

Registers a financial institution account using Plaid public token and returns the address ID

post/accounts/{account_id}/plaid/register-account

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

customer_webhook_urlstring uri required

URL where customer will receive webhook notifications when Plaid items need updates (required for account registration)

ownership'first_party' | 'third_party'

Ownership type of the financial institution. Defaults to third_party when not provided.

public_tokenstring required

The public token returned from Plaid Link

transfer_typesstring[] required

Transfer types to support for this financial institution

Example request

{
  "customer_webhook_url": "https://customer.com/webhooks/plaid-updates",
  "public_token": "public-sandbox-123456789",
  "transfer_types": [
    "ach_credit",
    "wire"
  ]
}

Response

Created

address_idstring required

The ID of the created address

Example response

{
  "address_id": "addr_123456789"
}