Fetch credential lifecycle status

GET

/v1/credentials/{credential_id}/status

const url = 'https://example.com/v1/credentials/example/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/credentials/example/status

Parameters

Path Parameters

credential_id

required

string

Responses

200

Credential status record

application/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": "valid",
  "updated_at": "2026-05-25T12:00:00Z"
}

404

Credential status is disabled or not found

application/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

Credential status store is unavailable

application/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"
}