POST

Create Plaid Link token

Creates a Plaid Link token for initiating the Plaid Link flow. The token is used to open Plaid Link in the client application, allowing users to connect their bank accounts. After the user completes the Plaid Link flow, use the /api/tradfi/v1/plaid/link/token/exchange endpoint with the returned token (as linkToken) and the publicToken received from Plaid Link to complete the bank account linking process.

Body Params

object

enterpriseId string required

The ID of the enterprise

at least 1 characters
androidPackageName string

The Android package name for OAuth redirect flows. Required when initializing Plaid Link on Android.
redirectUri string

The OAuth redirect URI for mobile and web flows.

Responses

201

Created

Response Body

object

data object required
data object
- token string required
  
  The Plaid Link token to use in the client
- expiration string date-time required
  
  The expiration time of the link token

404

Not Found - Enterprise not found or user does not have access

Response Body

object

errorName string required
error string required

424

Failed Dependency - Plaid service is unavailable

Response Body

object

errorName string required
error string required

428

Precondition Required - Plaid is not configured for this account

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl --request POST \ --url 'https://app.bitgo-test.com/api/tradfi/v1/plaid/link/token' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"enterpriseId":"string","androidPackageName":"string","redirectUri":"string"}'

const url = 'https://app.bitgo-test.com/api/tradfi/v1/plaid/link/token'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"enterpriseId":"string","androidPackageName":"string","redirectUri":"string"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/tradfi/v1/plaid/link/token") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"enterpriseId":"string","androidPackageName":"string","redirectUri":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/tradfi/v1/plaid/link/token', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"enterpriseId":"string","androidPackageName":"string","redirectUri":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/tradfi/v1/plaid/link/token" payload = {,"enterpriseId":"string","androidPackageName":"string","redirectUri":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)