Console operations / API reference

Read Console Credentials

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

GET/v1/console/operations/credentials

Authentication: Console sessionPermission: developers.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/credentials" \
  -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 · Verified human scoped owner projection

Field	Type	Description & constraints
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`observed_at`Required in parent object	`string`date-time	Defined by the resource contract.
`credentials`Required in parent object	`array`	Defined by the resource contract.
`credentials[].credential_id`Required in parent object	`string`	Defined by the resource contract.
`credentials[].public_id`Required in parent object	`string`	Defined by the resource contract.
`credentials[].institution_id`Required in parent object	`string`	Defined by the resource contract.
`credentials[].label`Required in parent object	`string`	Defined by the resource contract.
`credentials[].environment`Required in parent object	`string`	Defined by the resource contract.
`credentials[].status`Required in parent object	`string`	Defined by the resource contract.
`credentials[].created_at`Required in parent object	`string`	Defined by the resource contract.
`credentials[].updated_at`Required in parent object	`string`	Defined by the resource contract.

400 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

401 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

403 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

404 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

405 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

502 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

503 · Invalid, denied, missing, read-only or unavailable; never an empty success

Field	Type	Description & constraints
`code`Required in parent object	`string`	Defined by the resource contract.

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 →