Update an mDocs configuration

PUT/v2/credentials/mobile/configurations/{id}

Updates an existing mDocs configuration by providing its ID.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_STARTMOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESSMOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

mDocs configuration ID

Formatuuid

Request Body

application/json

Update an mDocs configuration

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \  -H "Content-Type: application/json" \  -d '{}'

{  "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": "org.iso.18013.5.1.mDL",  "claimMappings": {    "org.iso.18013.5.1": {      "given_name": {        "mapFrom": "claims.given_name",        "required": true,        "type": "string",        "display": [          {            "name": "Given Name",            "locale": "en-US"          },          {            "name": "Vorname",            "locale": "de-DE"          }        ]      },      "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"  }}

Update an mDocs configuration

PUT/v2/credentials/mobile/configurations/{id}

Updates an existing mDocs configuration by providing its ID.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_STARTMOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESSMOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

mDocs configuration ID

Formatuuid

Request Body

application/json

Update an mDocs configuration

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Used to differentiate between different mDocs configurations on your tenant. Thus, its value must:

Be unique across all mDocs configurations on your tenant.
Not be VerifiableCredential.
When set to org.iso.18013.5.*.mDL (where * is a positive integer), MATTR VII recognizes that this is attempt to create an mDL credential configuration and will fail if the validity period is set to 427 days or more.

Length1 <= length <= 1024

claimMappings*

This is where you specify how to map claims (user attributes) into issued credentials.

claimSourceId?string

References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.

Formatuuid

expiresIn*

Used to determine when issued credentials will expire, relative to issuance date:

Ignored if a valid validUntil date/time is provided.
Cannot be before the validFrom date/time.
If expiresIn is used to determine the credential's expiry date and validFrom is provided, the expiration date will still be calculated based on the issuance date, not the validFrom value.
Can include any combination of years, months, weeks, days, hours, minutes and seconds.
If type is set to org.iso.18013.5.*.mDL (for issuing an mDL), the maximum validity is 427 days.
For any other type, the maximum validity is 3620 days.

Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to IACA selection for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the expiresIn value exceeds the validity of all currently active IACAs at the time of issuance.

validFrom?

Specifies an explicit date and time from which the credential becomes valid.

Must be mapped from the provided user claims.
Must be formatted as a valid ISO 8601 date/time string.
If not provided, defaults to using the issuance date as the starting point for the credential's validity.
Cannot be after the credential's expiration date/time.
Cannot be before the credential's issuance date/time.

Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to IACA selection for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the validFrom value exceeds the validity of all currently active IACAs at the time of issuance.

validUntil?

Specifies an explicit date and time at which the credential expires.

Must be mapped from the provided user claims.
Must be formatted as a valid ISO 8601 date/time string.
If not provided, the expiration date will be determined based on the expiresIn value provided in the credential configuration.
Cannot be before the validFrom date/time.
If type is set to org.iso.18013.5.*.mDL (for issuing an mDL), the maximum validity is 427 days.
For any other type, the maximum validity is 3620 days.

Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to IACA selection for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the validUntil value exceeds the validity of all currently active IACAs at the time of issuance.

branding?

Used to apply branding to issued credentials.

Branding is written into each issued credential, in a private _branding field of the Mobile Security Object (MSO) that is covered by the issuer's signature. It is therefore available to the holder offline, and it travels with the credential when it is presented. It is also fixed at issuance, so updating branding here does not change credentials that have already been issued.

_branding is a custom extension element to ISO/IEC 18013-5 rather than a standardized feature, so holder and verifier applications need to be built to read it. MATTR SDKs and MATTR GO handle this out of the box. If you are working with other solutions, confirm that they read _branding before you rely on it for display. Applications that do not recognize the field ignore it.

includeStatus?boolean

When set to true, issued mDocs are revocable. They include a status object, which refers a Status list where the mDoc status is indicated. Revocable mDocs are issued as valid by default, but this status can later be changed to invalid or suspended.

Defaultfalse

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \  -H "Content-Type: application/json" \  -d '{}'

{  "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": "org.iso.18013.5.1.mDL",  "claimMappings": {    "org.iso.18013.5.1": {      "given_name": {        "mapFrom": "claims.given_name",        "required": true,        "type": "string",        "display": [          {            "name": "Given Name",            "locale": "en-US"          },          {            "name": "Vorname",            "locale": "de-DE"          }        ]      },      "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"  }}

How would you rate this page?

Update an mDocs configuration

Roles

Analytics Events

200application/json

400application/json

404application/json

Update an mDocs configuration

Roles

Analytics Events

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`