---
title: "Create Outside Instrument"
method: POST
path: "/connected-deposits/{version}/outside-instruments/create"
tags: ["Outside Instrument"]
---

# Create Outside Instrument

`POST /connected-deposits/{version}/outside-instruments/create`

## Request

- Base URL: `https://agw-ext.huntington.com`
- URL: `https://agw-ext.huntington.com/connected-deposits/{version}/outside-instruments/create`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/docs/connected-deposits/:version/outside-instruments/create/post.ts> (a function with typed inputs; its response is checked against the schema)

Create or Add an external financial instrument.

## Path parameters

- `version` string, required

## Headers

- `IdempotencyKey` string, uuid, required

## Request body

- CreateOutsideInstrumentRequest
  - `instrument_type` 'BANKDDA' | 'IBAN' | 'BBAN' | 'CARD' | 'CHECK', required
  - `instrument_category` 'INDIVIDUAL' | 'CORPORATE', required
  - `person_guid` string, uuid, required: Unique Person ID on Qolo Platform.
  - `instrument_country` string, required: Country of the instrument. Country 3-ISO code such as USA.
  - `financial_inst_name` string, nullable: Name of the financial institution owning the external instrument. ***required*** for bank instrument types
  - `account_details` AccountInfoCreate, required
    - `card_account` CardAccountCreate
      - `card_number` string, required: Card number
      - `expiration_date` string, required: Card expiration date to be provided in YYMM format- Example: November 2023 as 2311
      - `verification_code` string, required: Card verification value or code (Signature panel CVV2/CVC2)
    - `bank_account` BankAccountCreate
      - `account_type` 'DDA' | 'CHECKING' | 'SAVING'
      - `account_number` string: Bank Account number
      - `routing_number` string, nullable: For DDA types bank identification routing number
      - `name_on_account` string, nullable: Name on Account

## Response `201`

Returns the newly created outside instrument

- OutsideInstrumentDTO
  - `outside_instrument_guid` string, uuid
  - `person_guid` string, uuid
  - `instrument_country` string
  - `instrument_type` 'BANKDDA' | 'IBAN' | 'BBAN' | 'CARD' | 'CHECK'
  - `instrument_name` string, nullable
  - `instrument_settlement_currency` string, nullable
  - `instrument_category` 'INDIVIDUAL' | 'CORPORATE'
  - `instrument_usage` string, nullable
  - `mask_account_number` string, nullable
  - `account_details` AccountInfo: Base class for account info
    - `card_account` CardAccount: card account
      - `card_number` string, required: Card number
      - `expiration_date` string, required: Card expiration date to be provided in YYMM format- Example: November 2023 as 2311
      - `verification_code` string, nullable: Card verification value or code (Signature panel CVV2/CVC2)
    - `bank_account` BankAccount
      - `account_type` 'DDA' | 'CHECKING' | 'SAVING', required
      - `account_number` string, required: Bank Account number
      - `routing_number` string, nullable: For DDA types bank identification routing number
      - `bank_address` AddressDTO: Address details
        - `city` string
        - `country` string
        - `address_line1` string
        - `address_line2` string, nullable
        - `postal_code` string
        - `state` string
      - `name_on_account` string, nullable: Name on Account
  - `financial_inst_name` string, nullable
  - `instrument_status` 'ACTIVE' | 'SUSPEND' | 'NEGLIST' | 'FORGET' | 'UNPROVED' | 'REPLACED'

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Person not found
- `500`: Server Error

---

[API](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments.md) - [All operations](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/llms.txt) - [OpenAPI document](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/revisions/5beadf52eaee?raw)