Exchange / API reference
Read Approval
Request and response reference for GET /v1/exchange/approval-requests/{request}.
GET
/v1/exchange/approval-requests/{request}Authentication: Console sessionPermission: exchange.approvals.read
Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.
Request
This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/exchange/approval-requests/$REQUEST_ID" \
-H "Origin: $OSAI_APP_ORIGIN" \
--cookie "$OSAI_SESSION_COOKIE_FILE"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
request | path · string | Required | Use the value defined for this resource. |
Request body
This operation does not define a JSON request body.
Responses
Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.
200 · HTTP 200 response
| Field | Type | Description & constraints |
|---|---|---|
request_idRequired in parent object | string | Defined by the resource contract. |
institution_idRequired in parent object | string | Defined by the resource contract. |
maker_idRequired in parent object | string | Defined by the resource contract. |
statusRequired in parent object | string | Defined by the resource contract. |
dispatch_stateRequired in parent object | string | Defined by the resource contract. |
dispatch_reasonRequired in parent object | string | Defined by the resource contract. |
order_idOptional | string | Defined by the resource contract. |
snapshotRequired in parent object | object | Defined by the resource contract. |
snapshot.preview_idRequired in parent object | string | Defined by the resource contract. |
snapshot.market_idRequired in parent object | string | Defined by the resource contract. |
snapshot.market_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.instructionRequired in parent object | object | Defined by the resource contract. |
snapshot.instruction.command_idRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.kindRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.requestRequired in parent object | object | Defined by the resource contract. |
snapshot.instruction.request.institution_idRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.account_idRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.actor_idRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.client_order_idRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.sideRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.typeRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.time_in_forceRequired in parent object | string | Defined by the resource contract. |
snapshot.instruction.request.quantityRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.instruction.request.limit_priceRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.instruction.request.protection_priceRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.instruction.target_order_idOptional | string | Defined by the resource contract. |
snapshot.instruction.expected_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_scheduleRequired in parent object | object | Defined by the resource contract. |
snapshot.fee_schedule.schedule_idRequired in parent object | string | Defined by the resource contract. |
snapshot.fee_schedule.versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.effective_fromRequired in parent object | stringdate-time | Defined by the resource contract. |
snapshot.fee_schedule.effective_untilRequired in parent object | stringdate-time | Defined by the resource contract. |
snapshot.fee_schedule.makerRequired in parent object | object | Defined by the resource contract. |
snapshot.fee_schedule.maker.currencyRequired in parent object | string | Defined by the resource contract. |
snapshot.fee_schedule.maker.minor_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.maker.numeratorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.maker.denominatorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.maker.roundingRequired in parent object | string | Defined by the resource contract.Values: FLOOR, CEILING |
snapshot.fee_schedule.takerRequired in parent object | object | Defined by the resource contract. |
snapshot.fee_schedule.taker.currencyRequired in parent object | string | Defined by the resource contract. |
snapshot.fee_schedule.taker.minor_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.taker.numeratorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.taker.denominatorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.fee_schedule.taker.roundingRequired in parent object | string | Defined by the resource contract.Values: FLOOR, CEILING |
snapshot.taker_fee_at_boundRequired in parent object | object | Defined by the resource contract. |
snapshot.taker_fee_at_bound.currencyRequired in parent object | string | Defined by the resource contract. |
snapshot.taker_fee_at_bound.amount_minorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.taker_fee_at_bound.schedule_idRequired in parent object | string | Defined by the resource contract. |
snapshot.taker_fee_at_bound.schedule_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.maker_fee_at_boundRequired in parent object | object | Defined by the resource contract. |
snapshot.maker_fee_at_bound.currencyRequired in parent object | string | Defined by the resource contract. |
snapshot.maker_fee_at_bound.amount_minorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.maker_fee_at_bound.schedule_idRequired in parent object | string | Defined by the resource contract. |
snapshot.maker_fee_at_bound.schedule_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.exact_notional_at_boundRequired in parent object | object | Defined by the resource contract. |
snapshot.exact_notional_at_bound.currencyRequired in parent object | string | Defined by the resource contract. |
snapshot.exact_notional_at_bound.numeratorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.exact_notional_at_bound.denominatorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.book_sequenceRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.identity_policy_idRequired in parent object | string | Defined by the resource contract. |
snapshot.identity_policy_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
snapshot.created_atRequired in parent object | stringdate-time | Defined by the resource contract. |
snapshot.expires_atRequired in parent object | stringdate-time | Defined by the resource contract. |
snapshot.terms_hashRequired in parent object | string | Defined by the resource contract. |
approval_policyRequired in parent object | object | Defined by the resource contract. |
approval_policy.policy_idRequired in parent object | string | Defined by the resource contract. |
approval_policy.versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
approval_policy.required_distinct_approversRequired in parent object | integer | Defined by the resource contract. |
approval_policy.maximum_pending_requestsRequired in parent object | integer | Defined by the resource contract. |
approval_policy.maximum_retained_requestsRequired in parent object | integer | Defined by the resource contract. |
approval_policy.dispatch_lease_msRequired in parent object | integer | Defined by the resource contract. |
versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
decisionsRequired in parent object | array | Defined by the resource contract. |
decisions[].decision_idRequired in parent object | string | Defined by the resource contract. |
decisions[].membership_idRequired in parent object | string | Defined by the resource contract. |
decisions[].decisionRequired in parent object | string | Defined by the resource contract. |
decisions[].reasonRequired in parent object | string | Defined by the resource contract. |
decisions[].decided_atRequired in parent object | stringdate-time | Defined by the resource contract. |
created_atRequired in parent object | stringdate-time | Defined by the resource contract. |
expires_atRequired in parent object | stringdate-time | Defined by the resource contract. |
400 · Invalid bounded instruction
No client body fields are defined for this response.
401 · Authentication required
No client body fields are defined for this response.
403 · Permission, recent verified MFA or CSRF denied
No client body fields are defined for this response.
409 · Version, preview, instruction or capacity conflict
No client body fields are defined for this response.
410 · Frozen snapshot expired; request new terms and approval
No client body fields are defined for this response.
503 · Unavailable or unknown commit outcome; query the original command before retrying
No client body fields are defined for this response.
Retries & recovery
Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.