---
title: "Link Bank Account"
method: POST
path: "/bank-accounts"
tags: ["Linked Bank Accounts"]
---

# Link Bank Account

`POST /bank-accounts`

Links an external Bank Account.

## Request body

- LinkBankAccountReq
  - `userID` string, required — A unique identifier created for each User on DriveWealth's platform.
  - `bankAccountNumber` string, required — The account number of the user's external bank account.
  - `bankRoutingNumber` string, required — The routing number of the user's external bank.
  - `bankAccountType` 'CHECKING' | 'SAVINGS', required — The type of the user's external bank account.
  - `bankAccountNickname` string, required — The linked bank account nickname defined by the user.
  - `bankAccountPurpose` 'TRAVEL_RULE' | 'SETTLEMENT_PROFILE' — The linked account purpose.
  - `beneficiaryDetails` BeneficiaryDetails
    - `accountHolderName` string — The full name of the linked account holder.
    - `accountHolderAddress` string — The home address of the linked account holder.
    - `accountHolderCountry` string — The country of the linked account holder.
  - `bankName` string — The bank name of the linked account.
  - `bankAddress` string — The full address of the bank where the account is linked.
  - `bankCountry` string — The country of the bank where the account is linked.

## Response `200`

Links an external Bank Account to a User was Successful.

- LinkBankAccountRes
  - `id` string — The unique DriveWealth identifier that identifies each linked bank account.
  - `userDetails` object
    - `userID` string — A unique identifier created for each User on DriveWealth's platform.
    - `username` string — The username of the user.
    - `firstName` string — The first name of the user.
    - `lastName` string — The last (family) name of the user.
    - `email` string — The user's email address.
    - `parentIB` object
      - `id` string — The unique identifier of the firm.
      - `name` string — The firm name.
    - `wlpID` string — The wlpID is a deep backoffice ID that identifies each partner from each other.
    - `walletSettlementProfileID` string — The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners.
  - `bankAccountDetails` object
    - `bankAccountNumber` string — The last four digits of the user's external bank account number.
    - `bankRoutingNumber` string — The routing number of the user's external bank.
    - `bankAccountType` 'CHECKING' | 'SAVINGS' — The type of the user's external bank account.
    - `backAccountNickname` string — The linked bank account nickname defined by the user.
    - `bankName` string — The bank name of the linked account.
    - `bankAddress` object
      - `addressLine1` string — The full address of the bank where the account is linked.
      - `country` string — The country of the bank where the account is linked.
  - `bankAccountPurpose` 'TRAVEL_RULE' | 'SETTLEMENT_PROFILE' — The linked account purpose.
  - `beneficiaryDetails` BeneficiaryDetails
    - `accountHolderName` string — The full name of the linked account holder.
    - `accountHolderAddress` string — The home address of the linked account holder.
    - `accountHolderCountry` string — The country of the linked account holder.
  - `default` boolean — True, if the bank account is the user's default bank account. Only one bank account can be set to true.
  - `status` 'ACTIVE' | 'DELETED' | 'DISABLED' — The current status of the user's external linked bank account.
  - `created` string
  - `updated` string

---

[API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/versions/9fced6d0ac41/schema)