light-mode-image
Learn
API ReferenceHolder applications

Delete a registered holder application instance

Roles

adminholder

Analytics Events

CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_STARTCREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_SUCCESSCREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_FAIL
DELETE/v1/holder/applications/{applicationId}/instances/{instanceId}

Deletes a registered instance of a holder application.

Deleted instances will no longer be able to interact with the platform or receive tokens, and any existing tokens will be revoked.

Application owners can use this endpoint to remove individual instances that are no longer needed or were registered by mistake, without affecting the entire holder application or its other instances. This is useful for cleaning up test instances or managing specific devices, rather than deleting the whole application and all its associated instances.

Analytic events

  • CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_START
  • CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_SUCCESS
  • CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

applicationId*string

Unique identifier for a registered holder application.

Formatuuid
instanceId*string

Unique identifier for an instance of a registered holder application.

Formatuuid

Response Body

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v1/holder/applications/281d20b3-42a3-40dd-b29a-115ff32b02b7/instances/1ef1f867-20b4-48ea-aec1-bea7aff4964c"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?