---
title: "Get Status For ClientInstructionId"
method: GET
path: "/gw/api/v1/client-instructions/{clientInstructionId}"
tags: ["accountManagementBanking"]
---

# Get Status For ClientInstructionId

`GET /gw/api/v1/client-instructions/{clientInstructionId}`

Retrieve status of request by clientInstructionId.<br><br>**Scope**: `instructions.read`<br>**Security Policy**: `HTTPS`

## Path parameters

- `client-id` string, required
- `clientInstructionId` integer, required

## Response `200`

Returns the status of an instruction.

- union
  - InstructionPollingResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` PollingInstructionResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` PollingInstructionResultError
        - `errorCode` string, required
        - `errorMessage` string, required
  - InstructionResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` InstructionResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'PROCESSED' | 'REJECTED' | 'PENDING_VERIFICATION', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
  - QueryRecentInstructionResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryRecentInstructionResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` QueryRecentInstructionResultError
        - `errorCode` string, required
        - `errorMessage` string, required
      - `instructionHistory` QueryRecentInstructionResultInstructionHistory, required
        - `historyMaxDepthNumberOfDays` integer, required
        - `historyMaxDepthNumberOfInstruction` integer, required
        - `result` string[], required
  - DepositFundsPollingResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` DepositFundsPollingResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` DepositFundsPollingResultError
        - `errorCode` string, required
        - `errorMessage` string, required
      - `depositDetails` DepositFundsPollingResultDepositDetails
        - `amount` number, double
        - `currency` string
        - `whenAvailable` string
        - `openBanking` DepositFundsPollingResultDepositDetailsOpenBanking
          - `serviceProvider` string
          - `providerResponse` DepositFundsPollingResultDepositDetailsOpenBankingProviderResponse
  - QueryIRAContributionsResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryIRAContributionsResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` QueryIraContributionsResultError
        - `errorCode` string, required
        - `errorMessage` string, required
      - `accountId` string, required
      - `year` string, required
      - `iraType` string, required
      - `contributions` QueryIraContributionsResultContributionsItems[], required
        - `maximumContributionLimit` number, double, required
        - `yearToDateContribution` number, double, required
        - `allowedContributionLimit` number, double, required

## Other responses

- `404` — Returns a Problem detail instance representing a not found request.
- `500` — Unable to process request due to an Internal Error. Please try again later.

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)