Learn

Custom Domain

Configure custom domain

Creates a custom domain configuration on your tenant. You can configure a custom domain for a specific MATTR VII tenant to represent your brand and instil trust with your end-users. Any MATTR VII tenant can only have one custom domain. Refer to our docs for more information.

Custom domains are only available as part of our paid plans, and trial accounts do not include ongoing access to custom domains. The APIs are available for you to trial the feature, but they may be deactivated unless you switch to a paid plan.

Analytic events

  • CONFIG_CUSTOM_DOMAIN_CREATE_START
  • CONFIG_CUSTOM_DOMAIN_CREATE_SUCCESS
  • CONFIG_CUSTOM_DOMAIN_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema:
required

The custom domain payload

name
required
string

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.

logoUrl
required
string

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.
domain
required
string

Insert the full custom domain, leaving out the protocol (e.g. https://).

Responses
201

Custom domain created

400

Bad request, Invalid request body

post/core/v1/config/domain
Request samples
{}
Response samples
application/json
{
  • "name": "Example Corp",
  • "logoUrl": "https://cdn.example.com/logo.jpg",
  • "domain": "example.com",
  • "verificationToken": "8c6f36c1-91ff-439d-a518-48cf7ef421ef",
  • "isVerified": false
}

Retrieve custom domain

Returns your tenant's custom domain configuration and its verification status.

Analytic events

  • CONFIG_CUSTOM_DOMAIN_RETRIEVE_START
  • CONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESS
  • CONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL
SecuritybearerAuth
Responses
200

Custom domain returned

404

Not Found

get/core/v1/config/domain
Request samples 
Response samples 
application/json
{
  • "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"
}
Delete custom domain
Deletes the custom domain configuration on your tenant.




Deleting your custom domain configuration breaks the linkage with any credentials issued under the custom domain. These credentials will no longer be valid.




Analytic events


    

  • CONFIG_CUSTOM_DOMAIN_DELETE_START
    • 

  • CONFIG_CUSTOM_DOMAIN_DELETE_SUCCESS
    • 

  • CONFIG_CUSTOM_DOMAIN_DELETE_FAIL
    • 



SecuritybearerAuth 
Responses 
204
Custom domain deleted


404
Not Found


delete/core/v1/config/domain
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Update custom domain
Updates the custom domain configuration.


Analytic events


    

  • CONFIG_CUSTOM_DOMAIN_UPDATE_START
    • 

  • CONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESS
    • 

  • CONFIG_CUSTOM_DOMAIN_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
Request Body schema: application/json
id
string
 
name
required
string
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.


 
logoUrl
required
string
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.
    • 



 
domain
required
string
Insert the full custom domain, leaving out the protocol (e.g. https://).


 
Responses 
200
Custom Domain updated


404
Not Found


put/core/v1/config/domain
Request samples 
application/json
{}
Response samples 
application/json
{
  • "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"
}
Verify custom domain
Verifies that you have control of the configured custom domain by examining its TXT record.




Your custom domain will not be active until you verify it. Refer to Verify domain ownership for more information.




Analytic events


    

  • CONFIG_CUSTOM_DOMAIN_VERIFY_START
    • 

  • CONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESS
    • 

  • CONFIG_CUSTOM_DOMAIN_VERIFY_FAIL
    • 



SecuritybearerAuth 
Responses 
204
Custom domain verified


400
Bad Request


404
Not Found


post/core/v1/config/domain/verify
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to DIDs