Credentials / API reference
Revoke an institution credential
Request and response reference for DELETE /v1/credentials/{public_id}.
DELETE
/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.
curl -X DELETE "$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 revoked
| Field | Type | Description & constraints |
|---|---|---|
statusRequired in parent object | string | Defined by the resource contract.Values: revoked |
request_idRequired in parent object | string | Defined by the resource contract. |
403 · Credential changes are not entitled
No client body fields are defined for this response.
404 · Resource not found
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | object | Defined by the resource contract. |
error.codeRequired in parent object | string | Defined by the resource contract. |
error.messageRequired in parent object | string | Defined by the resource contract. |
error.request_idRequired 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.