Linked Bank Accounts

Link Bank Account

Links an external Bank Account.

post/bank-accounts

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/bank-accounts
Auth
HTTP bearer

Request body

userIDstring required

sensitive A unique identifier created for each User on DriveWealth's platform.

bankAccountNumberstring required

sensitive The account number of the user's external bank account.

bankRoutingNumberstring required

sensitive The routing number of the user's external bank.

bankAccountType'CHECKING' | 'SAVINGS' required

The type of the user's external bank account.

bankAccountNicknamestring required

The linked bank account nickname defined by the user.

bankAccountPurpose'TRAVEL_RULE' | 'SETTLEMENT_PROFILE'

The linked account purpose.

bankNamestring

The bank name of the linked account.

bankAddressstring

sensitive The full address of the bank where the account is linked.

bankCountrystring

The country of the bank where the account is linked.

Example request

{
  "userID": "123e4567-e89b-12d3-a456-000000000004",
  "bankAccountNumber": "7442393174",
  "bankRoutingNumber": "123456789",
  "bankAccountType": "CHECKING",
  "bankAccountNickname": "PREFERRED CHECKING",
  "bankAccountPurpose": "TRAVEL_RULE",
  "beneficiaryDetails": {
    "accountHolderName": "John Doe",
    "accountHolderAddress": "123 Main Street, New York, NY, 10001",
    "accountHolderCountry": "USA"
  },
  "bankName": "Bank of America",
  "bankAddress": "222 Broadway, New York City, NY, 10038",
  "bankCountry": "USA"
}

Response

Links an external Bank Account to a User was Successful.

idstring

The unique DriveWealth identifier that identifies each linked bank account.

bankAccountPurpose'TRAVEL_RULE' | 'SETTLEMENT_PROFILE'

The linked account purpose.

defaultboolean

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.

createdstring

updatedstring

Example response

{
  "id": "bank_123e4567-e89b-12d3-a456-00000000004a",
  "userDetails": {
    "userID": "123e4567-e89b-12d3-a456-000000000004",
    "username": "ttc.user.john",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.doe@example.com",
    "parentIB": {
      "id": "123e4567-e89b-12d3-a456-000000000005",
      "name": "Tendies Trading Company"
    },
    "wlpID": "TTC",
    "walletSettlementProfileID": "bank-profile-1"
  },
  "bankAccountDetails": {
    "bankAccountNumber": "****3174",
    "bankRoutingNumber": "123456789",
    "bankAccountType": "CHECKING",
    "backAccountNickname": "PREFERRED CHECKING",
    "bankName": "Bank of America",
    "bankAddress": {
      "addressLine1": "222 Broadway, New York City, NY, 10038",
      "country": "USA"
    }
  },
  "bankAccountPurpose": "TRAVEL_RULE",
  "beneficiaryDetails": {
    "accountHolderName": "John Doe",
    "accountHolderAddress": "123 Main Street, New York, NY, 10001",
    "accountHolderCountry": "USA"
  },
  "default": true,
  "status": "ACTIVE",
  "created": "2022-12-11T22:28:21.810Z",
  "updated": "2022-12-11T22:28:21.810Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.