BRbrale
Financial Institutions

Create update link token for existing bank account address

Changed on
post/accounts/{account_id}/addresses/{address_id}/update-link-token

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: addresses:read

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

address_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Address ID

Request body

android_package_namestring

Android package name for OAuth return-to-app. Must be pre-registered for the account and allowlisted in Plaid Dashboard. Required for Android OAuth flows. Cannot be used with redirect_uri.

client_namestring

Name of your application, as shown to users in Plaid Link. Defaults to Brale when not provided. Maximum 30 characters.

date_of_birthstring

User's date of birth (optional)

email_addressstring

User's email address (optional)

language'da' | 'nl' | 'en' | 'et' | 'fr' | 'de' | 'hi' | 'it' | 'lv' | 'lt' | 'no' | 'pl' | 'pt' | 'ro' | 'es' | 'sv' | 'vi'

Plaid Link UI language. Omit for English.

legal_namestring

User's legal name (optional)

phone_numberstring

User's phone number (optional)

redirect_uristring uri

Universal link for iOS OAuth return-to-app. Must be pre-registered for the account and allowlisted in Plaid Dashboard. Required for iOS OAuth flows. Cannot be used with android_package_name.

Example request

{
  "android_package_name": "com.example.myapp",
  "client_name": "Acme Payments",
  "date_of_birth": "1990-01-01",
  "email_address": "user@example.com",
  "language": "en",
  "legal_name": "John Doe",
  "phone_number": "+1234567890",
  "redirect_uri": "https://app.example.com/plaid-oauth"
}

Response

OK

callback_urlstring required

The URL to POST the public token tox after Plaid Link completion to register the account

expirationstring required

ISO 8601 timestamp when the link token expires

link_tokenstring required

The Plaid link token for bank authentication

Example response

{
  "callback_url": "http://localhost:4000/financial_institutions/register_account",
  "expiration": "2024-01-01T12:00:00Z",
  "link_token": "link-sandbox-123456789"
}

Changes

  • 8a7b57d41beeRevision changes
    • breaking

      added the new path request parameter address_id

    • warning

      deleted the path request parameter fi_id

    • info

      api operation id create_update_link_token (2) removed and replaced with create_address_update_link_token

    • info

      the security scope addresses:read was added to the endpoint's security scheme oauth

    • info

      the security scope financial-institutions:read was removed from the endpoint's security scheme oauth

  • fd1edeaad806Revision changes
    • info

      added the new optional request property