List supported output formats

GET

/v1/formats

const url = 'https://example.com/v1/formats';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

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/formats \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

apiKeyAuth
bearerAuth

Responses

200

Supported formats

application/json

Example

{
  "formats": [
    {
      "id": "application/dc+sd-jwt",
      "kind": "credential",
      "status": "enabled"
    },
    {
      "id": "application/ld+json; profile=\"cccev\"",
      "kind": "renderer",
      "status": "enabled"
    },
    {
      "id": "application/vnd.registry-notary.claim-result+json",
      "kind": "claim_result",
      "status": "enabled"
    }
  ]
}

401

Missing or invalid credential

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": "auth.missing_credential",
  "detail": "missing authentication credential",
  "status": 401,
  "title": "Missing credential",
  "type": "https://docs.registry-notary.dev/problems/auth/missing_credential"
}