Financial Institutions

Register financial institution account

Changed on

Registers a financial institution account using Plaid public token

post/accounts/{account_id}/financial-institutions/register-account

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: financial-institutions:write

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

account_holder_type'individual' | 'business'

Whether the bank account belongs to an individual or a business. Used when Plaid does not report it.

customer_webhook_urlstring uri required

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

public_tokenstring required

The public token returned from Plaid Link

Example request

{
  "customer_webhook_url": "https://customer.com/webhooks/plaid-updates",
  "public_token": "public-sandbox-123456789"
}

Response

OK

financial_institution_idstring required

The ID of the created financial institution

Example response

{
  "financial_institution_id": "fi_123456789"
}

Changes

    • info

      added the new optional request property

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status