Route status / API reference
Get entitled customer facing route availability and capabilities
Request and response reference for GET /v1/providers/status.
GET
/v1/providers/statusAuthentication: API key
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
Keep API keys in your backend. Required entitlements and institution scope still apply.
curl -X GET "$OSAI_API_BASE_URL/v1/providers/status" \
-H "Authorization: ApiKey $OSAI_PUBLIC_ID:$OSAI_API_SECRET"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
Authorization | header · string | Required | Use the value defined for this resource. |
X-Request-Id | header · string | Optional | 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 · Normalized customer-facing route status; provider identities are not exposed
| Field | Type | Description & constraints |
|---|---|---|
itemsRequired in parent object | array | Defined by the resource contract. |
items[].route_idRequired in parent object | string | Stable customer-facing route identifier, not a provider identity. |
items[].statusRequired in parent object | string | Defined by the resource contract.Values: AVAILABLE, UNAVAILABLE |
items[].capabilitiesRequired in parent object | array | Defined by the resource contract. |
request_idRequired in parent object | string | Defined by the resource contract. |
403 · The institution is not entitled to read provider status
No client body fields are defined for this response.
503 · Route status service 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.