light-mode-image
Learn

API Reference

Create a 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.

Analytic events

  • CONFIG_CUSTOM_DOMAIN_CREATE_START
  • CONFIG_CUSTOM_DOMAIN_CREATE_SUCCESS
  • CONFIG_CUSTOM_DOMAIN_CREATE_FAIL
POST/v1/config/domain

Authorization

AuthorizationBearer <token>

In: header

Request Body

The custom domain payload

namestring

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.

logoUrlstring

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.
domainstring

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

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

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
GET/v1/config/domain

Authorization

AuthorizationBearer <token>

In: header

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

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
PUT/v1/config/domain

Authorization

AuthorizationBearer <token>

In: header

Request Body

id?string
namestring

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.

logoUrlstring

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.
domainstring

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

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

Delete custom domain

Deletes the custom domain configuration on your tenant.

ℹ️ Note: 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
DELETE/v1/config/domain

Authorization

AuthorizationBearer <token>

In: header

curl -X DELETE "https://example.vii.au01.mattr.global/v1/config/domain"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Verify Custom domain

Verify custom domain

Verifies that you have control of the configured custom domain by examining its TXT record.

ℹ️ Note: 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
POST/v1/config/domain/verify

Authorization

AuthorizationBearer <token>

In: header

curl -X POST "https://example.vii.au01.mattr.global/v1/config/domain/verify"
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?

Guide

Previous Page

On this page

Create a Custom domainRetrieve Custom domainUpdate Custom domainDelete Custom domainVerify Custom domain