Skip to main content
GET
/
presets
/
credentials
Get credential presets.
curl --request GET \
  --url https://test.didxtech.com/me-creds/api/presets/credentials \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "credentialFormat": "sd-jwt",
      "id": "didx:basic-identity",
      "author": "didx",
      "code": "basic-identity",
      "templateName": "Basic Identity Credential",
      "templateType": "https://didx.co.za/vct/didx/basic-identity",
      "templateDescription": "XYZ Board of Directors approved basic identity credential template",
      "templateAttributes": {
        "firstName": {
          "type": "string",
          "name": "First Name",
          "description": "The first name of the person",
          "required": true,
          "alwaysDisclosed": false
        },
        "lastName": {
          "type": "string",
          "name": "Last Name",
          "description": "The last name of the person",
          "required": true,
          "alwaysDisclosed": false
        },
        "verified": {
          "type": "boolean",
          "name": "Verified",
          "description": "Whether the identity has been verified",
          "required": true,
          "alwaysDisclosed": true
        },
        "dateOfBirth": {
          "type": "date",
          "name": "Date of Birth",
          "description": "Date of birth of the person",
          "required": true,
          "alwaysDisclosed": false
        },
        "address": {
          "type": "object",
          "name": "Address",
          "description": "Residential address",
          "required": false,
          "alwaysDisclosed": false,
          "properties": {
            "streetName": {
              "type": "string",
              "name": "Street Name",
              "required": true,
              "alwaysDisclosed": false
            },
            "country": {
              "type": "string",
              "name": "Country",
              "required": true,
              "alwaysDisclosed": true
            }
          }
        },
        "nationalities": {
          "type": "array",
          "name": "Nationalities",
          "description": "List of Alpha-2 country codes representing nationalities",
          "required": false,
          "alwaysDisclosed": false,
          "items": {
            "type": "string"
          }
        }
      },
      "issuerConfig": {
        "signer": "did:web"
      },
      "createdAt": "2025-02-20T11:27:37.051Z",
      "updatedAt": "2025-02-20T11:27:37.051Z"
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "related": "<string>"
  },
  "meta": {},
  "errors": [
    {
      "detail": "<string>",
      "id": "<string>",
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

List of credential presets.

data
object[]
required
Example:
{
"credentialFormat": "sd-jwt",
"id": "didx:basic-identity",
"author": "didx",
"code": "basic-identity",
"templateName": "Basic Identity Credential",
"templateType": "https://didx.co.za/vct/didx/basic-identity",
"templateDescription": "XYZ Board of Directors approved basic identity credential template",
"templateAttributes": {
"firstName": {
"type": "string",
"name": "First Name",
"description": "The first name of the person",
"required": true,
"alwaysDisclosed": false
},
"lastName": {
"type": "string",
"name": "Last Name",
"description": "The last name of the person",
"required": true,
"alwaysDisclosed": false
},
"verified": {
"type": "boolean",
"name": "Verified",
"description": "Whether the identity has been verified",
"required": true,
"alwaysDisclosed": true
},
"dateOfBirth": {
"type": "date",
"name": "Date of Birth",
"description": "Date of birth of the person",
"required": true,
"alwaysDisclosed": false
},
"address": {
"type": "object",
"name": "Address",
"description": "Residential address",
"required": false,
"alwaysDisclosed": false,
"properties": {
"streetName": {
"type": "string",
"name": "Street Name",
"required": true,
"alwaysDisclosed": false
},
"country": {
"type": "string",
"name": "Country",
"required": true,
"alwaysDisclosed": true
}
}
},
"nationalities": {
"type": "array",
"name": "Nationalities",
"description": "List of Alpha-2 country codes representing nationalities",
"required": false,
"alwaysDisclosed": false,
"items": { "type": "string" }
}
},
"issuerConfig": { "signer": "did:web" },
"createdAt": "2025-02-20T11:27:37.051Z",
"updatedAt": "2025-02-20T11:27:37.051Z"
}
meta
object
errors
object[]