POST
/
v1
/
issuer
/
credential-definitions
/
{credentialDefinitionId}
/
archive
Archive an issuer credential definition
curl --request POST \
  --url https://sandbox.authbound.io/v1/issuer/credential-definitions/{credentialDefinitionId}/archive \
  --header 'X-Authbound-Key: <api-key>'
{
  "object": "<string>",
  "id": "pension_credential_v1",
  "credentialDefinitionId": "pension_credential_v1",
  "vct": "urn:vc:authbound:pension:1.0",
  "title": "Pension Credential",
  "claims": [
    {
      "name": "Pension.startDate",
      "path": [
        "Pension",
        "startDate"
      ],
      "mandatory": true,
      "displayName": "Start Date"
    }
  ],
  "aliases": [
    "<string>"
  ],
  "rendering": {
    "simple": {
      "text_color": "<string>",
      "background_color": "<string>"
    },
    "authbound_svg_template_preset": "<string>"
  },
  "metadata": {}
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Path Parameters

credentialDefinitionId
string
required

Credential definition ID

Required string length: 1 - 256

Response

Credential definition archived

object
string
required
Allowed value: "issuer.credential_definition"
id
string
required
Required string length: 1 - 256
Example:

"pension_credential_v1"

credentialDefinitionId
string
required
Required string length: 1 - 256
Example:

"pension_credential_v1"

format
enum<string>
required
Available options:
dc+sd-jwt,
mso_mdoc,
jwt_vc_json
vct
string
required
Required string length: 1 - 2048
Example:

"urn:vc:authbound:pension:1.0"

title
string
required
Required string length: 1 - 256
Example:

"Pension Credential"

claims
object[]
required
Maximum array length: 256
aliases
string[]
required
Maximum array length: 256
Maximum string length: 2048
lifecycleStatus
enum<string>
required
Available options:
draft,
published,
archived
Allowed value: "archived"
rendering
object
metadata
object

Caller-owned metadata for managing the definition. It is not embedded into issued credentials. Runtime additionally enforces eight JSON levels and 1,024 total nodes.