SPsphereon-opensource
StatusManagement

Update credential status

Updates the status of a credential in the status list. This endpoint supports updates by credentialId or statusListIndex, along with optional parameters for statusListId or correlation IDs.

post/credentials/status

Request

Query parameters

statusListIdstring

Optional status list identifier provided as a query parameter. Overrides default or body-specified value if present.

statusListCorrelationIdstring

Optional correlation ID for the status list. Overrides default or body-specified value if present.

entryCorrelationIdstring

Optional correlation ID for a specific entry in the status list. Overrides default or body-specified value if present.

Request body

statusListIdstring nullable

ID of the status list.

statusListCorrelationIdstring nullable

A correlation Id for the status list. This is typically a business key

credentialIdstring nullable

An optional credentialId if you kown the value. Can be used for a lookup instead of the statusListIndex or entryCorrelationId

statusListIndexnumber nullable

The index in the statusList. Needs to be provided in case a statusListIndex or entryCorrelationId is not used

entryCorrelationIdstring nullable

An entry correlation Id for the status list. This is typically a business key associated with an index. It allows you to associated business data in your Line of business system with this index, so you can update the status later on more easily

Response

Credential status updated successfully.

successboolean
statusesUpdatedinteger

Example response

{
  "success": true,
  "statusesUpdated": 1
}

Changes

No recorded changes to this operation across all 4 revisions of this API.