Skip to main content
POST
Withdraw credential

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

contactId
string
required
credentialId
string
required

Body

application/json
reason
string
required

Response

Success

id
string
required
contactId
string
required
kind
string
required
name
string | null
required
reference
string | null
required
provider
string | null
required
coverMinor
required
currency
string | null
required
issuedOn
string | null
required
expiresOn
string | null
required
documentId
string | null
required
status
string
required
supersededById
string | null
required
endedAt
string | null
required
endReason
string | null
required
actorUserId
string | null
required
actorName
string | null
required
createdAt
string
required