API Reference
Trusted issuers
Create a trusted issuer
Create a trusted issuer
Add a new mDocs trusted issuer, to be used in online presentation workflows.
Analytic events
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_START
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_SUCCESS
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_FAIL
POST
/v2/credentials/mobile/trusted-issuers
AuthorizationBearer <token>
In: header
The trusted issuer payload
certificatePem?string
Certificate PEM containing trusted issuer data. This PEM can represent a future-dated IACA to support seamless rotation.
curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/trusted-issuers" \ -H "Content-Type: application/json" \ -d '{}'
{
"id": "ed74319e-72a6-4401-b3a5-94e980fbebea",
"certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n",
"certificateData": {
"notAfter": "2033-09-23",
"notBefore": "2023-09-23",
"country": "NZ",
"commonName": "Example Trusted Issuer"
}
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve all trusted issuers (protected)
Retrieve all trusted issuers
Retrieves all mDocs trusted issuers from your tenant.
Analytic events
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_START
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_SUCCESS
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_FAIL
GET
/v2/credentials/mobile/trusted-issuers
AuthorizationBearer <token>
In: header
Query Parameters
limit?number
Range size of returned list.
Default
100
Range
1 <= value <= 1000
cursor?string
Starting point for the list of entries.
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/trusted-issuers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
"data": [
{
"id": "ed74319e-72a6-4401-b3a5-94e980fbebea",
"certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n",
"certificateData": {
"notAfter": "2033-09-23",
"notBefore": "2023-09-23",
"country": "NZ",
"commonName": "Example Trusted Issuer"
}
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve all trusted issuers (public)
Retrieve all trusted issuers
Retrieves all configured trusted issuers.
This endpoint is unprotected, public facing and can be used by any party wishing to retrieve the list of trusted issuers.
Analytic events
- CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_START
- CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_SUCCESS
- CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_FAIL
GET
/v2/presentations/trusted-issuers
curl -X GET "https://example.vii.au01.mattr.global/v2/presentations/trusted-issuers"
{
"iacas": [
{
"certificate": "string"
}
]
}
Retrieve a trusted issuer
Retrieve a trusted issuer
Retrieves an existing trusted issuer from your tenant by providing its ID.
Analytic events
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_START
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_SUCCESS
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_FAIL
GET
/v2/credentials/mobile/trusted-issuers/{id}
AuthorizationBearer <token>
In: header
Path Parameters
idstring
Trusted issuer ID
Format
uuid
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/trusted-issuers/3948c40e-6e19-4ffc-933c-91f643f24264"
{
"id": "ed74319e-72a6-4401-b3a5-94e980fbebea",
"certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n",
"certificateData": {
"notAfter": "2033-09-23",
"notBefore": "2023-09-23",
"country": "NZ",
"commonName": "Example Trusted Issuer"
}
}
{
"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 trusted issuer
Delete a trusted issuer
Deletes an existing trusted issuer by providing its ID.
Analytic events
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_START
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_SUCCESS
- MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_FAIL
DELETE
/v2/credentials/mobile/trusted-issuers/{id}
AuthorizationBearer <token>
In: header
Path Parameters
idstring
Trusted issuer ID
Format
uuid
curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/mobile/trusted-issuers/3948c40e-6e19-4ffc-933c-91f643f24264"
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?