Create a holder application

POST/v1/holder/applications

Creates a holder application. Once created, application instances can be registered and interact with the MATTR VII platform (for example, to claim credentials).

Analytic events

CREDENTIAL_HOLDER_APPLICATION_CREATE_START
CREDENTIAL_HOLDER_APPLICATION_CREATE_SUCCESS
CREDENTIAL_HOLDER_APPLICATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Holder application payload

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Unique name to identify the holder application.

clientId?string

OAuth 2.0 client_id value that the holder application uses when requesting client attestations. This value is included as the sub claim in attestation JWTs and must match the client_id configured on the Authorization Server.

type*string

Defines the holder application type.

Value in"ios"

bundleId*string

Bundle ID of the iOS app.

teamId*teamId

Team ID of the iOS app.

maxTimeOfflineInSecs?integer

Maximum number of seconds the SDK can operate offline before requiring a new license token.

Cannot be less than 1 day (86400 seconds).
Cannot exceed 30 days (2592000 seconds).
Default is 7 days (604800 seconds).

Default604800

Range86400 <= value <= 2592000

appAttest?

App Attest configuration for the iOS holder application.

name?string

Unique name to identify the holder application.

clientId?string

type*string

Defines the holder application type.

Value in"android"

packageName*string

Package name of the Android application that will interact with this holder application.

packageSigningCertificateThumbprints*array<string>

SHA-256 hex-encoded fingerprints of the signing key certificates that were used to sign the Android Package Kit (APK) or app bundle.
This ensures the holder tenant only accepts requests from known and trusted applications.
Any verification requests will fail if the certificate thumbprint does not match. Refer to Android app signing for more information.

maxTimeOfflineInSecs?integer

Maximum number of seconds the SDK can operate offline before requiring a new license token.

Cannot be less than 1 day (86400 seconds).
Cannot exceed 30 days (2592000 seconds).
Default is 7 days (604800 seconds).

Default604800

Range86400 <= value <= 2592000

keyAttestation?

Key Attestation configuration for the Android holder application.

Response Body

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v1/holder/applications" \  -H "Content-Type: application/json" \  -d '{    "name": "My Holder Application",    "clientId": "example-wallet-client",    "type": "ios",    "bundleId": "com.example-holder-ios-application",    "teamId": "A2B3C4D5E6"  }'

{
  "id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
  "name": "Example Holder Application",
  "clientId": "example-wallet-client",
  "type": "ios",
  "bundleId": "com.example-holder-ios-application",
  "teamId": "A2B3C4D5E6",
  "maxTimeOfflineInSecs": 86400,
  "appAttest": {
    "required": true,
    "environment": "production"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Create a holder application

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

`application/json`

`application/json`

Create a holder application

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`