Skip to main content
POST
Create a bank account link token

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Body

redirectUri
string

Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.

Minimum string length: 1
Example:

"https://app.example.com/plaid/oauth-return"

Response

Response for status 200

Token to initialize Plaid Link SDK

Plaid-hosted URL for bank linking. Spritz requests Hosted Link for every link token; open this URL in a browser or webview when non-null. If Plaid does not return a hosted URL, use the embedded/native linkToken flow.

expiration
string
required
requestId
string
required