light-mode-image
Learn
API Reference

Credential types

Create a Credential type

Create credential type

Creates a new credential type in the requested ecosystem.

Analytic events

  • ECOSYSTEM_CREDENTIAL_CREATE_START
  • ECOSYSTEM_CREDENTIAL_CREATE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_CREATE_FAIL
POST/v1/ecosystems/{ecosystemId}/credentials

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

Request Body

profilestring
Value in"compact" | "compact-semantic" | "web-semantic"
typestring
namestring

The name of the credential

Length1 <= length <= 50
profilestring
Value in"mobile"
docTypestring
namestring

The name of the credential

Length1 <= length <= 50
curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/credentials" \  -H "Content-Type: application/json" \  -d '{    "profile": "compact",    "type": "DriverLicense",    "name": "Driver\'s License"  }'
{
  "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
  "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  "profile": "compact",
  "type": "DriverLicense",
  "name": "Driver's License"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
Empty

Retrieve all Credential types

Retrieve credential types

Retrieves a list of credential types from the requested ecosystem.

Analytic events

  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_START
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_FAIL
GET/v1/ecosystems/{ecosystemId}/credentials

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemIdstring

The UUID of the ecosystem

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "data": [
    {
      "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
      "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
      "profile": "compact",
      "type": "DriverLicense",
      "name": "Driver's License"
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a Credential type

Retrieve credential type

Retrieves a credential type from the requested ecosystem by its ID.

Analytic events

  • ECOSYSTEM_CREDENTIAL_RETRIEVE_START
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_FAIL
GET/v1/ecosystems/{ecosystemId}/credentials/{credentialId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemIdstring

The UUID of the ecosystem

Formatuuid
credentialIdstring

The UUID of the credential

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/credentials/599bf148-d711-405a-a20b-9c8a87ac8850"
{
  "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
  "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  "profile": "compact",
  "type": "DriverLicense",
  "name": "Driver's License"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a Credential type

Delete credential type

Deletes a credential type from the requested ecosystem by its ID.

Analytic events

  • ECOSYSTEM_CREDENTIAL_DELETE_START
  • ECOSYSTEM_CREDENTIAL_DELETE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_DELETE_FAIL
DELETE/v1/ecosystems/{ecosystemId}/credentials/{credentialId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/credentials/599bf148-d711-405a-a20b-9c8a87ac8850"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Participants

Previous Page

Participant assignment

Next Page

On this page

Create a Credential typeRetrieve all Credential typesRetrieve a Credential typeDelete a Credential type