API Reference
Create a Custom domain
/v1/config/domainAuthorization
bearerAuth In: header
The custom domain payload
Insert a name for the custom domain that will be displayed to digital wallet holders when they receive credential offers or verification requests from this tenant.
Insert a URL for a square logo that will be displayed to digital wallet holders when they receive credential offers or verification requests from your MATTR VII tenant:
- URL must be publicly available.
- Must be a square image, recommended 64x64 px in size
- png and jpg files are supported.
- The recommended maximum size is 15 KB.
Insert the full custom domain, leaving out the protocol (e.g. https://).
Response Body
application/json
application/json
curl -X POST "https://example.vii.au01.mattr.global/v1/config/domain" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Corp", "logoUrl": "https://cdn.example.com/logo.jpg", "domain": "example.com" }'{
"name": "Example Corp",
"logoUrl": "https://cdn.example.com/logo.jpg",
"domain": "example.com",
"verificationToken": "8c6f36c1-91ff-439d-a518-48cf7ef421ef",
"isVerified": false
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Retrieve Custom domain
/v1/config/domainAuthorization
bearerAuth In: header
Response Body
application/json
application/json
curl -X GET "https://example.vii.au01.mattr.global/v1/config/domain"{
"name": "Example Corp",
"logoUrl": "https://cdn.example.com/logo.icon",
"domain": "example.com",
"verificationToken": "8c6f36c1-91ff-439d-a518-48cf7ef421ef",
"isVerified": true,
"verifiedAt": "2024-01-31T20:31:48.340Z"
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Update Custom domain
/v1/config/domainAuthorization
bearerAuth In: header
Request Body
application/json
Insert a name for the custom domain that will be displayed to digital wallet holders when they receive credential offers or verification requests from this tenant.
Insert a URL for a square logo that will be displayed to digital wallet holders when they receive credential offers or verification requests from your MATTR VII tenant:
- URL must be publicly available.
- Must be a square image, recommended 64x64 px in size
- png and jpg files are supported.
- The recommended maximum size is 15 KB.
Insert the full custom domain, leaving out the protocol (e.g. https://).
Response Body
application/json
application/json
curl -X PUT "https://example.vii.au01.mattr.global/v1/config/domain" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Corp", "logoUrl": "https://cdn.example.com/logo.jpg", "domain": "example.com" }'{
"name": "Example Corp",
"logoUrl": "https://cdn.example.com/logo.icon",
"domain": "example.com",
"verificationToken": "8c6f36c1-91ff-439d-a518-48cf7ef421ef",
"isVerified": true,
"verifiedAt": "2021-04-15T07:37:25.008Z"
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Delete Custom domain
/v1/config/domainAuthorization
bearerAuth In: header
Response Body
application/json
curl -X DELETE "https://example.vii.au01.mattr.global/v1/config/domain"{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Verify Custom domain
/v1/config/domain/verifyAuthorization
bearerAuth In: header
Response Body
application/json
application/json
curl -X POST "https://example.vii.au01.mattr.global/v1/config/domain/verify"{
"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?