> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.upwardli.com/api-access/api-reference/onboarding/create-link-bank-account/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.upwardli.com/_mcp/server.

# Create Link Bank Account

POST https://api.upwardli.com/v2/onboarding/{external_id}/link-bank-account/
Content-Type: application/json

View used to start the "Link Bank Account" step on an existing Onboarding

Reference: https://developers.upwardli.com/api-access/api-reference/onboarding/create-link-bank-account

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.upwardli.com` (Production, default)
- `https://api-sandbox.upwardli.com` (Sandbox)

## Request

### Path parameters

- `external_id` (string, required)

### Body (application/json)

This endpoint expects a LinkBankAccount.

- `plaid_link_token` (string, required)

## Response

### 201

- `id` (string, required)
- `status` (string, required)
- `consumer` (OnboardResponseConsumer, required)
- `kyc` (OnboardResponseKyc, required)
- `e_sign` (OnboardResponseESign, required)
- `underwriting` (OnboardResponseUnderwriting, required)
- `product` (OnboardResponseProduct, required)
- `previous_steps` (list of OnboardResponsePreviousStepsItems, required)
- `current_steps` (list of OnboardResponseCurrentStepsItems, required, nullable)
- `metadata` (OnboardResponseMetadata, required, nullable)

## Types

### OnboardResponseConsumer

- `id` (string, required)
- `pcid` (string, required)
- `mla_status` (boolean, required)
- `external_id` (string, optional)
- `first_name` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `email` (string, optional, nullable)
- `is_active` (boolean, optional)
- `kyc_status` (string, optional)
- `phone_number` (string, optional)
- `date_of_birth` (string, optional)
- `tax_id_type` (string, optional)
- `tax_identifier` (string, optional, nullable)
- `address_line1` (string, optional)
- `address_line2` (string, optional)
- `address_city` (string, optional)
- `address_state` (string, optional)
- `address_zip` (string, optional)
- `credit_lines` (string, optional, nullable)

### OnboardResponseKyc

- `inquiry_ids` (list of string, required, nullable)
- `fallback_inquiry_id` (string, required)
- `inquiry_template_id` (string, required)
- `errors` (string, optional)

### OnboardResponseESign

- `agreement_accepted` (boolean, required)
- `agreement_accepted_date` (string, required, nullable)

### OnboardResponseUnderwriting

- `result` (string, required)
- `data` (string, required)
- `errors` (list of any, required, nullable)

### OnboardResponseProduct

- `product_id` (string, required)
- `product_configuration` (OnboardResponseProductProductConfiguration, required, nullable)

### OnboardResponsePreviousStepsItems

- `slug` (string, required)
- `url` (string, required)

### OnboardResponseCurrentStepsItems

- `slug` (string, required)
- `url` (string, required)

### OnboardResponseMetadata

### OnboardResponseProductProductConfiguration

## Examples

**Request**

```json
{
  "plaid_link_token": "string"
}
```

**Response**

```json
{
  "id": "string",
  "status": "string",
  "consumer": {
    "id": "string",
    "pcid": "string",
    "mla_status": true,
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "is_active": true,
    "kyc_status": "string",
    "phone_number": "string",
    "date_of_birth": "string",
    "tax_id_type": "string",
    "tax_identifier": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_zip": "string",
    "credit_lines": "string"
  },
  "kyc": {
    "inquiry_ids": [
      "string"
    ],
    "fallback_inquiry_id": "string",
    "inquiry_template_id": "string",
    "errors": "string"
  },
  "e_sign": {
    "agreement_accepted": true,
    "agreement_accepted_date": "2024-01-15T09:30:00Z"
  },
  "underwriting": {
    "result": "string",
    "data": "string",
    "errors": [
      null
    ]
  },
  "product": {
    "product_id": "string",
    "product_configuration": {}
  },
  "previous_steps": [
    {
      "slug": "string",
      "url": "string"
    }
  ],
  "current_steps": [
    {
      "slug": "string",
      "url": "string"
    }
  ],
  "metadata": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/"

payload = { "plaid_link_token": "string" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"plaid_link_token":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/"

	payload := strings.NewReader("{\n  \"plaid_link_token\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"plaid_link_token\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"plaid_link_token\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/', [
  'body' => '{
  "plaid_link_token": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"plaid_link_token\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["plaid_link_token": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.upwardli.com/v2/onboarding/external_id/link-bank-account/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```