Get Status For InstructionId

View as MarkdownOpen in Claude

Retrieve status of request by instructionId

Scope: instructions.read
Security Policy: HTTPS

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Path parameters

client-idstringRequired
The client's clientId
instructionIdlongRequired
The target instruction id.

Response

Returns the status of an instruction.
InstructionPollingResponseobject
Polling response for a submitted instruction.
OR
InstructionResponseobject
Response acknowledging a submitted instruction.
OR
QueryRecentInstructionResponseobject
Response containing recent instructions for an account.
OR
DepositFundsPollingResponseobject
Polling response for a deposit funds instruction.
OR
QueryIRAContributionsResponseobject
Response containing IRA contribution information for an account.

Errors

404
Not Found Error
500
Internal Server Error