Skip to content
Registry StackDocsLatest
Search

Update credential lifecycle status

POST
/admin/v1/credentials/{credential_id}/status
curl --request POST \
  --url https://example.com/admin/v1/credentials/example/status \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --data '{ "status": "valid" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
credential_id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
status
required
string
Allowed values: valid suspended revoked

Responses

Section titled “Responses”

200

Section titled “200”

Updated credential status record

Media typeapplication/json
Example
{
  "credential_id": "urn:ulid:01HX7Y5F2WAJ7ZP0Q4M5K9E8NC",
  "credential_profile": "civil_status_sd_jwt",
  "expires_at": "2026-05-25T12:10:00Z",
  "issued_at": "2026-05-25T12:00:00Z",
  "issuer": "did:web:issuer.example",
  "status": "revoked",
  "updated_at": "2026-05-25T12:00:00Z"
}

400

Section titled “400”

Invalid status value

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "credential_status.invalid_status",
  "detail": "status must be valid, suspended, or revoked",
  "status": 400,
  "title": "Invalid credential status",
  "type": "https://docs.registry-notary.dev/problems/credential_status/invalid_status"
}

401

Section titled “401”

Missing or invalid credential

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "missing authentication credential",
  "status": 401,
  "title": "Missing credential",
  "type": "https://docs.registry-notary.dev/problems/auth/missing_credential"
}

403

Section titled “403”

Caller lacks registry_notary:admin scope

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.scope_denied",
  "detail": "missing required scope",
  "status": 403,
  "title": "Scope denied",
  "type": "https://docs.registry-notary.dev/problems/auth/scope_denied"
}

404

Section titled “404”

Credential status is disabled or not found

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "credential_status.not_found",
  "detail": "credential status record was not found",
  "status": 404,
  "title": "Credential status not found",
  "type": "https://docs.registry-notary.dev/problems/credential_status/not_found"
}

503

Section titled “503”

Credential status store is unavailable

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "credential_status.unavailable",
  "detail": "credential status store is unavailable",
  "status": 503,
  "title": "Credential status unavailable",
  "type": "https://docs.registry-notary.dev/problems/credential_status/unavailable"
}