Credentials / API reference

Get institution credential metadata

Request and response reference for GET /v1/credentials/{public_id}.

GET/v1/credentials/{public_id}

Authentication: 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.

Request templatecURL

curl -X GET "$OSAI_API_BASE_URL/v1/credentials/$PUBLIC_ID" \
  -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.
`public_id`	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 · Credential metadata; secret material is never returned

Field	Type	Description & constraints
`public_id`Required in parent object	`string`	Defined by the resource contract.
`label`Required in parent object	`string`	Defined by the resource contract.
`environment`Required in parent object	`string`	Defined by the resource contract.
`status`Required in parent object	`string`	Defined by the resource contract.Values: ACTIVE, REVOKED, EXPIRED
`created_at`Required in parent object	`string`date-time	Defined by the resource contract.
`request_id`Required in parent object	`string`	Defined by the resource contract.

404 · Resource not found

Field	Type	Description & constraints
`error`Required in parent object	`object`	Defined by the resource contract.
`error.code`Required in parent object	`string`	Defined by the resource contract.
`error.message`Required in parent object	`string`	Defined by the resource contract.
`error.request_id`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 →