Sign in

v3

latestOpenAPI 3.0.32026-07-31489099.0 KB
Financial Institutions

Create Plaid link token

Creates a Plaid link token for bank authentication

post/accounts/{account_id}/plaid/link_token

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account 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.

date_of_birthstring

User's date of birth (optional)

email_addressstring

User's email address (optional)

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",
  "date_of_birth": "1990-01-01",
  "email_address": "user@example.com",
  "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"
}