Skip to main content

Configure credential types

Credential types define what credentials are valid in the ecosystem.

tip

This does not mean that other credentials cannot be issued or verified in the ecosystem - that is up to the customer business logic to determine. It only means that these are the only credentials that are considered valid (Level 2 trust).

Request​

Make the following request to configure a new credential type:

POST https://api.sovrin.one/v1/ecosystems/{ecosystemId}/credentials
  • ecosystemId: Credential types must be configured within a specific ecosystem. Use the ecosystem unique id obtained when you created the ecosystem.
{
  "profile": "compact",
  "type": "DriverLicence",
  "name": "Driver's Licence"
}

  • profile: Insert the profile of the new credential (web-semantic, compact-semantic, compact or mobile).

  • type: Insert the type of the new credential.

  • name: Insert a meaningful name for the new credential.

Response​

{
  "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
  "ecosystemId": "6f219af9-edc2-4840-b8e7-05b27f28751d",
  "profile": "compact",
  "type": "DriverLicence",
  "name": "Driver's Licence"
}

  • id: A unique identifier for the new credential. This identifier is used when creating a policy.

  • ecosystemId: The requested ecosystem identifier.

tip

When required, ecosystem operators can revoke an existing credential type so that it is no longer considered valid in the ecosystem.

What's Next?​

Your ecosystem now has valid participants and credential types. You can now combine the two to create policies.