Getting started

Welcome to MATTR VII!

By now, you should have been provided with the following details, required for accessing and engaging with your MATTR VII tenant:

If you have not received these details or have any questions, please contact us before proceeding.

json
Copy to clipboard.
1{
2    "audience": "YOUR_AUDIENCE_URL",
3    "url": "YOUR_AUTH_URL",
4    "tenant_subdomain": "YOUR_TENANT_SUBDOMAIN",
5    "client_id": "YOUR_CLIENT_ID",
6    "client_secret": "YOUR_CLIENT_SECRET"
7}
  • audience: The MATTR VII server your tenant will access. You will use it to complete authentication.

  • url: Our authentication provider URL. You will use it to complete authentication.

  • tenant_subdomain: Your MATTR VII tenant subdomain URL. You will use it to make API requests to your tenant.

  • client_id: Unique id for accessing your MATTR VII tenant. You will use it to complete authentication.

  • client_secret: Unique secret for accessing your MATTR VII tenant. You will use it to complete authentication.

Authentication

Before you can make any API requests to your MATTR VII tenant, you must complete authentication by obtaining an API access token from our authentication provider. Refer to the authentication section of the API Reference for more information.

Use values from your tenant details to make the following request:

Request

http
Copy to clipboard.
1POST https://{auth_server}/oauth/token
  • auth_server: Replace with the url value from your tenant details.

json
Copy to clipboard.
1{
2    "client_id": "YOUR_CLIENT_ID",
3    "client_secret": "YOUR_CLIENT_SECRET",
4    "audience": "YOUR_AUDIENCE_URL",
5    "grant_type": "client_credentials"
6}
  • client_id: Replace with the client_id value from your tenant details.

  • client_secret: Replace with the client_secret value from your tenant details.

  • audience: Replace with the audience value from your tenant details.

  • grant_type: Use client_credentials.

Response

json
Copy to clipboard.
1{
2    "access_token": "YOUR_ACCESS_TOKEN",
3    "expires_in": 14400,
4    "token_type": "Bearer"
5}

The returned access_token value must be used as a bearer token for all subsequent requests to protected resources on your tenant.

Verify your access token

A good test to ensure that you can access your MATTR VII tenant is to retrieve a list of DIDs.

First, use the tenant_subdomain value from your tenant details to construct the URL you will use to make API requests to your tenant:

http
Copy to clipboard.
1https://{tenant_subdomain}.vii.au01.mattr.global
  • tenant_subdomain: Replace with the tenant_subdomain value from your tenant details.

This is the base URL you should use for all API requests to your tenant, suffixed by the required endpoint. This URL is referenced as YOUR_TENANT_URL across our tutorials.

Request

Use your tenant URL and the returned bearer token to make the following request:

http
Copy to clipboard.
1GET https://YOUR_TENANT_URL/v1/dids

Response

Success is indicated by a returned 200 HTTP status code. As you’ve likely not yet created any DIDs, we would expect an empty array as a response:

[]

The fact that a 200 HTTP status code was returned indicates that your bearer token has permitted access to the protected resource.

We recommend using our Postman collection to interact with your MATTR VII tenant. This collection includes a pre-request script to obtain an access token when it is missing or expired.

What's next?

You are now ready to start creating your digital trust ecosystem:

  • Learn more about the fundamentals of digital trust ecosystems in our Docs section.

  • Get hands on MATTR VII experience in our Tutorials section.

  • Browse all available MATTR VII APIs in our API Reference.