DevelopersOsai website ↗
API v1
Company access / API reference

Read Audit

Request and response reference for GET /v1/console/audit.

GET/v1/console/audit
Authentication: Console sessionPermission: audit.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/audit" \
  -H "Origin: $OSAI_APP_ORIGIN" \
  --cookie "$OSAI_SESSION_COOKIE_FILE"

Parameters

NameLocationRequirementDescription
afterquery · stringOptionalUse 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
FieldTypeDescription & constraints
entriesRequired in parent objectarrayDefined by the resource contract.
entries[].idRequired in parent objectstringExact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$
entries[].institution_idRequired in parent objectstringDefined by the resource contract.
entries[].actor_membership_idRequired in parent objectstringDefined by the resource contract.
entries[].actionRequired in parent objectstringDefined by the resource contract.
entries[].target_idRequired in parent objectstringDefined by the resource contract.
entries[].outcomeRequired in parent objectstringDefined by the resource contract.
entries[].metadataRequired in parent objectobjectDefined by the resource contract.
entries[].metadata.reasonOptionalstringDefined by the resource contract.
entries[].metadata.policy_idOptionalstringDefined by the resource contract.
entries[].metadata.policy_versionOptionalstringExact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$
entries[].metadata.before_rolesOptionalarrayDefined by the resource contract.
entries[].metadata.after_rolesOptionalarrayDefined by the resource contract.
entries[].metadata.before_statusOptionalstringDefined by the resource contract.
entries[].metadata.after_statusOptionalstringDefined by the resource contract.
entries[].metadata.evidence_referenceOptionalstringDefined by the resource contract.
entries[].metadata.session_referenceOptionalstringDefined by the resource contract.
entries[].metadata.auth_timeOptionalstringDefined by the resource contract.
entries[].occurred_atRequired in parent objectstringdate-timeDefined by the resource contract.
entries[].previous_hashRequired in parent objectstringDefined by the resource contract.
entries[].entry_hashRequired in parent objectstringDefined by the resource contract.
next_afterRequired in parent objectstringExact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$
has_moreRequired in parent objectbooleanDefined 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.

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.

16 suggested pages

Get startedIntroductionIntegrate institutional FX and stablecoin trading with quotes, orders, market data, account records and settlement reporting.Get startedQuickstartMake an authenticated read, request a quote and follow an instruction without losing its original references.Get startedAuthenticationUse the correct authentication scheme for API credentials, Console sessions and market-data feeds.Get startedErrorsDistinguish invalid inputs, denied access, conflicts, rate limits and uncertain outcomes.Get startedRate limitsUse response headers, bounded concurrency and backoff rather than repeated bursts.Get startedAmounts & precisionKeep minor-unit money, fixed-point FX rates and instrument-scaled quantities exact.Get startedPagination & recoveryUse each resource’s pagination model and preserve stable recovery checkpoints.Financial workflowsQuotes & acceptanceRequest explicit FX economics, review conditions and retain accepted terms.Financial workflowsTrade lifecycleTrack funding, execution and settlement as distinct business transitions.Financial workflowsBalances & transactionsRead institutional financial positions and reconcile movements by currency.Financial workflowsBeneficiariesRegister beneficiaries and coordinate their institutional approval lifecycle.Financial workflowsCredential managementCreate, inspect, rotate and revoke application credentials without exposing secrets.Events & reliabilityIdempotencyPrevent duplicate financial effects across retries and uncertain outcomes.Events & reliabilityWebhooks & verificationVerify deliveries, persist original events and make downstream processing idempotent.Events & reliabilityEvent payloadsUnderstand the customer event envelope and business transitions behind subscriptions.Events & reliabilityDelivery retries & replayRepair webhook delivery without creating a second business event.