Company access / API reference
Resolve Company Workspace
Request and response reference for GET /api/auth/company/{slug}.
GET
/api/auth/company/{slug}Authentication: Unauthenticated
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 entry point does not require an existing session. Applicable onboarding, origin and verification policies still apply.
curl -X GET "$OSAI_CONSOLE_BASE_URL/api/auth/company/$SLUG_ID"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
slug | 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 |
|---|---|---|
slugRequired in parent object | string | Defined by the resource contract.Pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$ |
login_urlRequired in parent object | stringuri | Defined by the resource contract. |
403 · Unknown, inactive or mismatched company
No client body fields are defined for this response.
503 · Identity unavailable
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.