Console operations / API reference

Credentialrevocations Console

Request and response reference for POST /v1/console/operations/credential-revocations.

POST/v1/console/operations/credential-revocations

Authentication: UnauthenticatedPermission: developers.credentials.revoke

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.

Request templatecURL

curl -X POST "$OSAI_CONSOLE_BASE_URL/v1/console/operations/credential-revocations" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: <stable-operation-key>" \
  --data '{
  "command_id": "<command_id>",
  "resource_id": "<resource_id>",
  "reason": "<reason>"
}'

Parameters

Name	Location	Requirement	Description
`Idempotency-Key`	header · string	Required	Use the value defined for this resource.
`X-CSRF-Token`	header · string	Required	Use the value defined for this resource.

Request body

Send JSON with Content-Type: application/json. Nested field names identify their parent object; required markers apply within that object. Replace template values using the relevant resource and configured instrument rules.

Field	Type	Description & constraints
`command_id`Required in parent object	`string`	Defined by the resource contract.Pattern: `^[A-Za-z0-9:_-]{1,128}$`
`resource_id`Required in parent object	`string`	Defined by the resource contract.Pattern: `^[A-Za-z0-9:_-]{1,128}$`
`reason`Required in parent object	`string`	Defined by the resource contract.
`expected_updated_at`Optional	`string`date-time	Defined by the resource contract.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · Owner atomic effect and immutable receipt; replay queued is not delivery confirmation

Field	Type	Description & constraints
`command_id`Required in parent object	`string`	Defined by the resource contract.
`resource_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`membership_id`Required in parent object	`string`	Defined by the resource contract.
`status`Required in parent object	`string`	Defined by the resource contract.
`recorded_at`Required in parent object	`string`date-time	Defined by the resource contract.

400 · Invalid instruction