Skip to main content
PATCH
Update a credential

Authorizations

Authorization
string
header
required

JWT token authentication

Headers

NexSpace-Version
string

Pin the request to a dated API version (e.g. 2026-05-10). Applied by app-level middleware to every /api route (server/routes/index.ts → apiVersionMiddleware), which echoes the resolved value back in the NexSpace-Version response header. Omit to get the latest version. Discover the catalog at GET /.well-known/api-versions.

Pattern: ^\d{4}-\d{2}-\d{2}$
Idempotency-Key
string

Replay guard for write requests. Applied by app-level middleware to every /api route (server/routes/index.ts → idempotencyMiddleware), which only acts on POST/PUT/PATCH — GET, DELETE and OPTIONS ignore the header. Re-sending the same key with an identical body within 24 hours replays the original response; the same key with a different body returns 409.

Maximum string length: 255

Path Parameters

id
integer
required

Credential ID

Body

application/json

Partial credential update. Every field is optional; only the keys you send are forwarded to the storage layer.

type
string
name
string
issuer
string
issueDate
string<date>
expirationDate
string<date>
fileUrl
string

Response

The stored credential

id
integer

Unique credential identifier

userId
integer | null

ID of the user the credential belongs to

type
string

Credential type (e.g., license, certification, training)

name
string

Human-readable credential name

issuer
string | null

Issuing authority or organization

issueDate
string<date> | null

Date the credential was issued

expirationDate
string<date> | null

Date the credential expires

status
enum<string>

Current verification/validity status

Available options:
active,
expiring,
expired,
pending,
rejected
fileUrl
string | null

URL to the uploaded credential document