Update an alias - Mintlify Starter Kit

curl --request PATCH \
  --url "https://directory.example.com/dids/did%3Atalaria%3A1111111111111111111111/aliases/river.stone" \
  --header "Content-Type: application/json" \
  --data '{
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "nonce": "<nonce>",
  "timestamp": "2026-07-16T12:00:00Z",
  "valid_until": "2026-07-16T12:05:00Z",
  "signer_key_id": "did:talaria:1111111111111111111111#root",
  "canonical_payload": "<payload>",
  "signature": "<signature>"
}'

{
  "status": "accepted",
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "tx_hash": "<transaction-hash>",
  "message": "Alias update submitted"
}

curl --request PATCH \
  --url "https://directory.example.com/dids/did%3Atalaria%3A1111111111111111111111/aliases/river.stone" \
  --header "Content-Type: application/json" \
  --data '{
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "nonce": "<nonce>",
  "timestamp": "2026-07-16T12:00:00Z",
  "valid_until": "2026-07-16T12:05:00Z",
  "signer_key_id": "did:talaria:1111111111111111111111#root",
  "canonical_payload": "<payload>",
  "signature": "<signature>"
}'

{
  "status": "accepted",
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "tx_hash": "<transaction-hash>",
  "message": "Alias update submitted"
}

Replace an existing public alias.

Path parameters

did

string

required

The DID that owns the alias.

oldAlias

string

required

The existing alias.

Request body

did

string

required

The DID that owns the alias. It must match the path.

action

string

required

The operation name. Use update_alias.

old_alias

string

required

The existing alias. It must match the path.

new_alias

string

required

The replacement alias.

nonce

string

required

The request nonce.

timestamp

string

required

The request timestamp.

valid_until

string

required

The authorization expiration time.

signer_key_id

string

The public signing-key identifier. Defaults to root.

canonical_payload

string

required

The payload supplied by a Talaria-compatible signer.

signature

string

required

The authorization signature.

curl --request PATCH \
  --url "https://directory.example.com/dids/did%3Atalaria%3A1111111111111111111111/aliases/river.stone" \
  --header "Content-Type: application/json" \
  --data '{
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "nonce": "<nonce>",
  "timestamp": "2026-07-16T12:00:00Z",
  "valid_until": "2026-07-16T12:05:00Z",
  "signer_key_id": "did:talaria:1111111111111111111111#root",
  "canonical_payload": "<payload>",
  "signature": "<signature>"
}'

Response

{
  "status": "accepted",
  "did": "did:talaria:1111111111111111111111",
  "action": "update_alias",
  "old_alias": "river.stone",
  "new_alias": "river.rock",
  "tx_hash": "<transaction-hash>",
  "message": "Alias update submitted"
}

202 Accepted means the Directory accepted the request for processing. It does not confirm final settlement.

Add an alias Remove an alias

⌘I

​Path parameters

​Request body

​Response

Path parameters

Request body

Response