mDoc credentials configuration

Create an mDocs configuration

Creates a new mDocs configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.

Analytic events

MOBILE_CREDENTIAL_CONFIGURATION_CREATE_START
MOBILE_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS
MOBILE_CREDENTIAL_CONFIGURATION_CREATE_FAIL

SecuritybearerAuth

Request

Request Body schema: application/json
required

The mDocs configuration payload

type required	string [ 1 .. 1024 ] characters 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 recognises that this is attempt to create an mDL credential configuration and will fail if the validity period is set to 447 days or more.
required	object (ClaimMappings) This is where you specify how to map claims (user attributes) into issued credentials.
claimSourceId	string <uuid> References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.
required	object Used to determine when will issued credentials expire. Can include any combination of years, months, weeks, days, hours, minutes and seconds. When `type` is set to `org.iso.18013.5..mDL` (where `` is a positive integer), MATTR VII recognises that this is an mDL credential configuration and will fail if `expiresIn` is 447 days or more.
	object Used to apply branding to issued credentials.
includeStatus	boolean Default: false 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.

Responses

201

mDocs configuration created

400

Bad Request

post/v2/credentials/mobile/configurations

Request samples

application/json

{"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
},
"branding": {"name": "Credential name",
"description": "Credential Description",
"backgroundColor": "#FFFFFF",
"watermarkImage": "data:image/png;base64,{image-data}",
"issuerLogo": "https://example-path-to-image-data.com",
"issuerIcon": "data:image/svg+xml;base64,{image-data}"
},
"includeStatus": true
}

Response samples

application/json

{"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
}
}

Retrieve all mDocs configurations

Retrieves all mDocs configurations from your tenant.

Analytic events

MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START
MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS
MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL

SecuritybearerAuth

Request

query Parameters

limit	number [ 1 .. 1000 ] Default: 100 Range size of the list, default 100 Example: limit=2
cursor	string Starting point for the list Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
type	string Optional credential type to filter on Example: type=AlumniCredential

Responses

200

mDocs configurations retrieved

400

Bad Request

get/v2/credentials/mobile/configurations

Request samples

Response samples

application/json

{"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
}
}
]
}

Retrieve an mDocs configuration

Retrieves an existing mDocs configuration by providing its ID.

Analytic events

MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_START
MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS
MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL

SecuritybearerAuth

Request

path Parameters

required

string <uuid>

mDocs configuration ID

Example: 3948c40e-6e19-4ffc-933c-91f643f24264

Responses

200

mDocs configuration retrieved

400

Bad Request

404

mDocs configuration Not Found

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

Request samples

Response samples

application/json

{"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
}
}

Update an mDocs configuration

Updates an existing mDocs configuration by providing its ID.

Analytic events

MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_START
MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS
MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL

SecuritybearerAuth

Request

path Parameters

required

string <uuid>

mDocs configuration ID

Example: 3948c40e-6e19-4ffc-933c-91f643f24264

Request Body schema: application/json
required

Update an mDocs configuration

type required	string [ 1 .. 1024 ] characters 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 recognises that this is attempt to create an mDL credential configuration and will fail if the validity period is set to 447 days or more.
required	object (ClaimMappings) This is where you specify how to map claims (user attributes) into issued credentials.
claimSourceId	string <uuid> References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.
required	object Used to determine when will issued credentials expire. Can include any combination of years, months, weeks, days, hours, minutes and seconds. When `type` is set to `org.iso.18013.5..mDL` (where `` is a positive integer), MATTR VII recognises that this is an mDL credential configuration and will fail if `expiresIn` is 447 days or more.
	object Used to apply branding to issued credentials.
includeStatus	boolean Default: false 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.

Responses

200

mDocs configuration updated

400

Bad Request

404

mDocs configuration not Found

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

Request samples

application/json

{"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
},
"branding": {"name": "Credential name",
"description": "Credential Description",
"backgroundColor": "#FFFFFF",
"watermarkImage": "data:image/png;base64,{image-data}",
"issuerLogo": "https://example-path-to-image-data.com",
"issuerIcon": "data:image/svg+xml;base64,{image-data}"
},
"includeStatus": true
}

Response samples

application/json

{"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
}
}

Delete an mDocs configuration

Deletes an existing mDocs configuration by providing its ID.

Analytic events

MOBILE_CREDENTIAL_CONFIGURATION_DELETE_START
MOBILE_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS
MOBILE_CREDENTIAL_CONFIGURATION_DELETE_FAIL

SecuritybearerAuth

Request

path Parameters

required

string <uuid>

mDocs configuration ID

Example: 3948c40e-6e19-4ffc-933c-91f643f24264

Responses

204

mDocs configuration deleted

400

Bad Request

404

mDocs configuration not Found

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

Request samples

Response samples

application/json

{"code": "BadRequest",
"message": "Validation Error",
"details": [{"location": "params",
"msg": "Invalid value",
"param": "id",
"value": "abc"
}
]
}

➔ Next to Credential issuance

mDoc credentials configuration

Create an mDocs configuration

Analytic events

Request Body schema: application/jsonrequired

Retrieve all mDocs configurations

Analytic events

query Parameters

Retrieve an mDocs configuration

Analytic events

path Parameters

Update an mDocs configuration

Analytic events

path Parameters

Request Body schema: application/jsonrequired

Delete an mDocs configuration

Analytic events

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required