Console operations / API reference

Read Console Beneficiaries

Request and response reference for GET /v1/console/operations/beneficiaries.

GET/v1/console/operations/beneficiaries

Authentication: Console sessionPermission: beneficiaries.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.

Request templatecURL

curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/console/operations/beneficiaries" \
  -H "Origin: $OSAI_APP_ORIGIN" \
  --cookie "$OSAI_SESSION_COOKIE_FILE"

Parameters

No endpoint-specific path or query parameters are defined. Authentication and access policy still apply.

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 · Institution-scoped owner evidence; no external finality inferred

Field	Type	Description & constraints
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`observed_at`Required in parent object	`string`	Defined by the resource contract.
`source`Required in parent object	`string`	Defined by the resource contract.
`items`Required in parent object	`array`	Defined by the resource contract.
`items[].beneficiary_id`Required in parent object	`string`	Defined by the resource contract.
`items[].name`Required in parent object	`string`	Defined by the resource contract.
`items[].bank_code`Required in parent object	`string`	Defined by the resource contract.
`items[].account_last_four`Required in parent object	`string`	Defined by the resource contract.
`items[].status`Required in parent object	`string`	Defined by the resource contract.
`items[].approval_status`Required in parent object	`string`	Defined by the resource contract.
`items[].updated_at`Required in parent object	`string`	Defined by the resource contract.

400 · Invalid query

No client body fields are defined for this response.

401 · Session required

No client body fields are defined for this response.

403 · Permission denied

No client body fields are defined for this response.

503 · Owner unavailable; no scenario fallback

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.

Error handling →Idempotency →