Retrieve all mDocs configurations

Retrieves all mDocs configurations from your tenant.

Analytics Events

MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL

Roles

adminissuer

GET/v2/credentials/mobile/configurations

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100

Range1 <= value <= 1000

cursor?string

Starting point for the list of entries.

type?string

Optional credential type to filter on

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential"

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential"

{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  "data": [
    {
      "id": "983c0a86-204f-4431-9371-f5a22e506599",
      "branding": {
        "name": "Credential name",
        "description": "Credential Description",
        "backgroundColor": "#FFFFFF",
        "watermarkImage": "data:image/png;base64,{image-data}",
        "issuerLogo": "data:image/png;base64,{image-data}",
        "issuerIcon": "data:image/svg+xml;base64,{image-data}"
      },
      "includeStatus": true,
      "type": "DriverLicense",
      "claimMappings": {
        "org.iso.18013.5.1": {
          "given_name": {
            "mapFrom": "claims.given_name",
            "required": true,
            "type": "string"
          },
          "birth_date": {
            "mapFrom": "claims.date_of_birth",
            "required": true,
            "type": "dateTime"
          }
        }
      },
      "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
      "expiresIn": {
        "years": 0,
        "months": 1,
        "weeks": 0,
        "days": 0,
        "hours": 0,
        "minutes": 0,
        "seconds": 0
      },
      "validFrom": {
        "mapFrom": "string"
      },
      "validUntil": {
        "mapFrom": "string"
      }
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}