POST
/
v1
/
issuer
/
credential-definitions
Create an issuer credential definition
curl --request POST \
  --url https://sandbox.authbound.io/v1/issuer/credential-definitions \
  --header 'Content-Type: application/json' \
  --header 'X-Authbound-Key: <api-key>' \
  --data '
{
  "credentialDefinitionId": "pension_credential_v1",
  "vct": "urn:vc:authbound:pension:1.0",
  "title": "Pension Credential",
  "claims": [
    {
      "path": [
        "Pension",
        "startDate"
      ],
      "mandatory": false,
      "displayName": "Start Date"
    }
  ],
  "lifecycleStatus": "published",
  "aliases": [
    "pension",
    "pension_credential"
  ],
  "rendering": {
    "simple": {
      "text_color": "<string>",
      "background_color": "<string>"
    },
    "authbound_svg_template_preset": "<string>"
  },
  "metadata": {}
}
'
{
  "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).

Headers

Idempotency-Key
string

Unique key for idempotent requests

Maximum string length: 255

Body

application/json
credentialDefinitionId
string
required
Required string length: 1 - 256
Example:

"pension_credential_v1"

vct
string
required
Required string length: 1 - 2048
Example:

"urn:vc:authbound:pension:1.0"

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

"Pension Credential"

claims
object[]
required
Required array length: 1 - 256 elements
lifecycleStatus
enum<string>
required

Published creation must satisfy publish readiness.

Available options:
published
aliases
string[]
Maximum array length: 256
Required string length: 1 - 2048
Example:
["pension", "pension_credential"]
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.

Response

Credential definition created

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: "draft"
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.