API Reference

Create a Custom domain

POST/v1/config/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.

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_CREATE_STARTCONFIG_CUSTOM_DOMAIN_CREATE_SUCCESSCONFIG_CUSTOM_DOMAIN_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

The custom domain payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/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}

Retrieve Custom domain

GET/v1/config/domain

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

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_RETRIEVE_STARTCONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESSCONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/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"}

Update Custom domain

PUT/v1/config/domain

Updates the custom domain configuration.

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_UPDATE_STARTCONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESSCONFIG_CUSTOM_DOMAIN_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/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"}

Delete Custom domain

DELETE/v1/config/domain

Deletes the custom domain configuration on your tenant.

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_DELETE_STARTCONFIG_CUSTOM_DOMAIN_DELETE_SUCCESSCONFIG_CUSTOM_DOMAIN_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/config/domain"

Empty

Verify Custom domain

POST/v1/config/domain/verify

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

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_VERIFY_STARTCONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESSCONFIG_CUSTOM_DOMAIN_VERIFY_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "https://example.com/v1/config/domain/verify"

Empty

Create a Custom domain

POST/v1/config/domain

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_CREATE_STARTCONFIG_CUSTOM_DOMAIN_CREATE_SUCCESSCONFIG_CUSTOM_DOMAIN_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

The custom domain payload

TypeScript Definitions

Use the request body type in TypeScript.

name*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*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*string

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

Response Body

`application/json`

curl -X POST "https://example.com/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}

Retrieve Custom domain

GET/v1/config/domain

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

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_RETRIEVE_STARTCONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESSCONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/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"}

Update Custom domain

PUT/v1/config/domain

Updates the custom domain configuration.

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_UPDATE_STARTCONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESSCONFIG_CUSTOM_DOMAIN_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

name*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*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*string

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

Response Body

`application/json`

curl -X PUT "https://example.com/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"}

Delete Custom domain

DELETE/v1/config/domain

Deletes the custom domain configuration on your tenant.

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_DELETE_STARTCONFIG_CUSTOM_DOMAIN_DELETE_SUCCESSCONFIG_CUSTOM_DOMAIN_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/config/domain"

Empty

Verify Custom domain

POST/v1/config/domain/verify

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

Roles

adminissuerverifierdts-providermanaged-issuer

Analytics Events

CONFIG_CUSTOM_DOMAIN_VERIFY_STARTCONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESSCONFIG_CUSTOM_DOMAIN_VERIFY_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "https://example.com/v1/config/domain/verify"

Empty

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

204

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

API Reference

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

204

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`