@twin.org/node 0.0.3-next.33 → 0.0.3-next.34

package/docs/open-api/spec.json

@@ -19,6 +19,10 @@
 			"name": "Info",
 			"description": "Information endpoints for the REST server."
 		},
+		{
+			"name": "Health",
+			"description": "Health endpoints for the REST server."
+		},
 		{
 			"name": "Authentication",
 			"description": "Authentication endpoints for the REST server."
@@ -123,34 +127,72 @@
 	"paths": {
 		"/": {
 			"get": {
-				"operationId": "serverRoot",
-				"summary": "Get the root text page",
+				"operationId": "serverHealth",
+				"summary": "Get the health for the server",
 				"tags": [
-					"Info"
+					"Health"
 				],
 				"responses": {
 					"200": {
-						"description": "The root text for the server.",
+						"description": "The health of the server.",
 						"content": {
-							"text/plain": {
+							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/ServerRootResponse"
+									"$ref": "#/components/schemas/ServerHealthResponse"
 								},
 								"examples": {
-									"serverRootResponse": {
-										"summary": "The response for the root request.",
-										"value": "API Server - 1.0.0"
+									"healthResponseOK": {
+										"summary": "The response for the health request.",
+										"value": {
+											"status": "ok",
+											"components": [
+												{
+													"name": "Database",
+													"status": "ok"
+												},
+												{
+													"name": "Storage",
+													"status": "ok"
+												}
+											]
+										}
+									},
+									"healthResponseWarning": {
+										"summary": "The response for the health request with warnings.",
+										"value": {
+											"status": "warning",
+											"components": [
+												{
+													"name": "Database",
+													"status": "warning",
+													"description": "slowRunning"
+												},
+												{
+													"name": "Storage",
+													"status": "ok"
+												}
+											]
+										}
+									},
+									"healthResponseError": {
+										"summary": "The response for the health request with errors.",
+										"value": {
+											"status": "error",
+											"components": [
+												{
+													"name": "Database",
+													"status": "ok"
+												},
+												{
+													"name": "Storage",
+													"status": "error",
+													"description": "storageFull"
+												}
+											]
+										}
 									}
 								}
 							}
-						},
-						"headers": {
-							"content-type": {
-								"schema": {
-									"type": "string"
-								},
-								"description": "e.g. text/plain"
-							}
 						}
 					},
 					"400": {
@@ -342,11 +384,11 @@
 								"examples": {
 									"livezResponseOK": {
 										"summary": "The response for the liveness request.",
-										"value": "ok"
+										"value": "alive"
 									},
 									"livezResponseFailure": {
 										"summary": "The response for the liveness request with errors.",
-										"value": "failed"
+										"value": "dead"
 									}
 								}
 							}
@@ -402,74 +444,40 @@
 				}
 			}
 		},
-		"/health": {
+		"/readyz": {
 			"get": {
-				"operationId": "serverHealth",
-				"summary": "Get the health for the server",
+				"operationId": "serverReadyz",
+				"summary": "Get the readyz status for the server",
 				"tags": [
 					"Info"
 				],
 				"responses": {
 					"200": {
-						"description": "The health of the server.",
+						"description": "The readyz of the server.",
 						"content": {
-							"application/json": {
+							"text/plain": {
 								"schema": {
-									"$ref": "#/components/schemas/HealthInfo"
+									"$ref": "#/components/schemas/ServerReadyzResponse"
 								},
 								"examples": {
-									"healthResponseOK": {
-										"summary": "The response for the health request.",
-										"value": {
-											"status": "ok",
-											"components": [
-												{
-													"name": "Database",
-													"status": "ok"
-												},
-												{
-													"name": "Storage",
-													"status": "ok"
-												}
-											]
-										}
-									},
-									"healthResponseWarning": {
-										"summary": "The response for the health request with warnings.",
-										"value": {
-											"status": "warning",
-											"components": [
-												{
-													"name": "Database",
-													"status": "warning",
-													"details": "The database is running slow."
-												},
-												{
-													"name": "Storage",
-													"status": "ok"
-												}
-											]
-										}
+									"readyzResponseOK": {
+										"summary": "The response for the readiness request.",
+										"value": "ready"
 									},
-									"healthResponseError": {
-										"summary": "The response for the health request with errors.",
-										"value": {
-											"status": "error",
-											"components": [
-												{
-													"name": "Database",
-													"status": "ok"
-												},
-												{
-													"name": "Storage",
-													"status": "error",
-													"details": "The storage is full."
-												}
-											]
-										}
+									"readyzResponseFailure": {
+										"summary": "The response for the readiness request with errors.",
+										"value": "not ready"
 									}
 								}
 							}
+						},
+						"headers": {
+							"content-type": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. text/plain"
+							}
 						}
 					},
 					"400": {
@@ -691,24 +699,31 @@
 			}
 		},
 		"/authentication/logout": {
-			"get": {
+			"post": {
 				"operationId": "authenticationLogout",
 				"summary": "Logout from the server",
 				"tags": [
 					"Authentication"
 				],
-				"parameters": [
-					{
-						"name": "token",
-						"description": "The token to logout, if it uses a mechanism with public access.",
-						"in": "query",
-						"required": false,
-						"schema": {
-							"type": "string"
-						},
-						"example": "eyJhbGciOiJIU...sw5c"
+				"requestBody": {
+					"description": "Perform a logout on the auth token.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/LogoutRequest"
+							},
+							"examples": {
+								"logoutRequestExample": {
+									"summary": "The request to logout from the server.",
+									"value": {
+										"token": "eyJhbGciOiJIU...sw5c"
+									}
+								}
+							}
+						}
 					}
-				],
+				},
 				"responses": {
 					"204": {
 						"description": "The rest request ended in success with no data."
@@ -756,29 +771,36 @@
 			}
 		},
 		"/authentication/refresh": {
-			"get": {
+			"post": {
 				"operationId": "authenticationRefreshToken",
 				"summary": "Refresh an authentication token",
 				"tags": [
 					"Authentication"
 				],
-				"parameters": [
-					{
-						"name": "token",
-						"description": "The token to refresh, if it uses a mechanism with public access.",
-						"in": "query",
-						"required": false,
-						"schema": {
-							"type": "string"
-						},
-						"example": "eyJhbGciOiJIU...sw5c"
-					}
-				],
 				"security": [
 					{
 						"jwtBearerAuthScheme": []
 					}
 				],
+				"requestBody": {
+					"description": "Perform a refresh of the auth token.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/RefreshTokenRequest"
+							},
+							"examples": {
+								"refreshTokenRequestExample": {
+									"summary": "The request to refresh an auth token.",
+									"value": {
+										"token": "eyJhbGciOiJIU...sw5c"
+									}
+								}
+							}
+						}
+					}
+				},
 				"responses": {
 					"200": {
 						"description": "Response from a refresh on the auth token.",
@@ -2624,35 +2646,24 @@
 				}
 			}
 		},
-		"/identity/{identity}/verifiable-credential/{verificationMethodId}": {
+		"/identity/{identity}/alias": {
 			"post": {
-				"operationId": "identityVerifiableCredentialCreate",
-				"summary": "Create an identity verifiable credential",
+				"operationId": "identityAlsoKnownAsCreate",
+				"summary": "Add an alias to the alsoKnownAs property on the document",
 				"tags": [
 					"Identity"
 				],
 				"parameters": [
 					{
 						"name": "identity",
-						"description": "The identity to create the verification credential for.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
-					},
-					{
-						"name": "verificationMethodId",
-						"description": "The verification method id to use.",
+						"description": "The identity to create the alias for.",
 						"in": "path",
 						"required": true,
 						"schema": {
 							"type": "string"
 						},
 						"style": "simple",
-						"example": "my-assertion"
+						"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
 					}
 				],
 				"security": [
@@ -2661,24 +2672,17 @@
 					}
 				],
 				"requestBody": {
-					"description": "Request to create a verifiable credential.",
+					"description": "Request to create an alias for an identity.",
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateRequest"
+								"$ref": "#/components/schemas/IdentityAlsoKnownAsCreateRequest"
 							},
 							"examples": {
-								"identityVerifiableCredentialCreateRequestExample": {
+								"identityAlsoKnownAsCreateRequestExample": {
 									"value": {
-										"credentialId": "https://example.com/credentials/3732",
-										"subject": {
-											"@context": "https://schema.org",
-											"@type": "Person",
-											"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
-											"name": "Jane Doe"
-										},
-										"revocationIndex": 5
+										"alias": "did:example:123"
 									}
 								}
 							}
@@ -2686,44 +2690,8 @@
 					}
 				},
 				"responses": {
-					"200": {
-						"description": "Response to creating a verifiable credential.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateResponse"
-								},
-								"examples": {
-									"identityVerifiableCredentialCreateResponseExample": {
-										"value": {
-											"verifiableCredential": {
-												"@context": [
-													"https://www.w3.org/2018/credentials/v1",
-													"https://schema.org"
-												],
-												"id": "https://example.com/credentials/3732",
-												"type": [
-													"VerifiableCredential",
-													"Person"
-												],
-												"credentialSubject": {
-													"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
-													"name": "Jane Doe"
-												},
-												"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
-												"issuanceDate": "2025-01-24T09:21:51.500Z",
-												"credentialStatus": {
-													"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
-													"type": "BitstringStatusList",
-													"revocationBitmapIndex": "5"
-												}
-											},
-											"jwt": "eyJraWQiOi...D1Z3AQ"
-										}
-									}
-								}
-							}
-						}
+					"204": {
+						"description": "The rest request ended in success with no data."
 					},
 					"400": {
 						"description": "The server cannot process the request, see the content for more details.",
@@ -2785,26 +2753,287 @@
 				}
 			}
 		},
-		"/identity/verifiable-credential/verify/document": {
-			"post": {
-				"operationId": "identityVerifiableCredentialVerifyDocument",
-				"summary": "Verify an identity verifiable credential document",
+		"/identity/{identity}/alias/{alias}": {
+			"delete": {
+				"operationId": "identityAlsoKnownAsRemove",
+				"summary": "Remove an alias from the alsoKnownAs property on the document",
 				"tags": [
 					"Identity"
 				],
-				"requestBody": {
-					"description": "Request to verify a verifiable credential.",
-					"required": true,
-					"content": {
-						"application/json": {
-							"schema": {
-								"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
-							},
-							"examples": {
-								"identityVerifiableCredentialVerifyDocumentRequestExample": {
-									"value": {
-										"@context": [
-											"https://www.w3.org/2018/credentials/v1",
+				"parameters": [
+					{
+						"name": "identity",
+						"description": "The identity to remove the alias from.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
+					},
+					{
+						"name": "alias",
+						"description": "The alias to remove.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "did:example:123"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/identity/{identity}/verifiable-credential/{verificationMethodId}": {
+			"post": {
+				"operationId": "identityVerifiableCredentialCreate",
+				"summary": "Create an identity verifiable credential",
+				"tags": [
+					"Identity"
+				],
+				"parameters": [
+					{
+						"name": "identity",
+						"description": "The identity to create the verification credential for.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
+					},
+					{
+						"name": "verificationMethodId",
+						"description": "The verification method id to use.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-assertion"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to create a verifiable credential.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateRequest"
+							},
+							"examples": {
+								"identityVerifiableCredentialCreateRequestExample": {
+									"value": {
+										"credentialId": "https://example.com/credentials/3732",
+										"subject": {
+											"@context": "https://schema.org",
+											"@type": "Person",
+											"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+											"name": "Jane Doe"
+										},
+										"revocationIndex": 5
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Response to creating a verifiable credential.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateResponse"
+								},
+								"examples": {
+									"identityVerifiableCredentialCreateResponseExample": {
+										"value": {
+											"verifiableCredential": {
+												"@context": [
+													"https://www.w3.org/2018/credentials/v1",
+													"https://schema.org"
+												],
+												"id": "https://example.com/credentials/3732",
+												"type": [
+													"VerifiableCredential",
+													"Person"
+												],
+												"credentialSubject": {
+													"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+													"name": "Jane Doe"
+												},
+												"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+												"issuanceDate": "2025-01-24T09:21:51.500Z",
+												"credentialStatus": {
+													"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+													"type": "BitstringStatusList",
+													"revocationBitmapIndex": "5"
+												}
+											},
+											"jwt": "eyJraWQiOi...D1Z3AQ"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/identity/verifiable-credential/verify/document": {
+			"post": {
+				"operationId": "identityVerifiableCredentialVerifyDocument",
+				"summary": "Verify an identity verifiable credential document",
+				"tags": [
+					"Identity"
+				],
+				"requestBody": {
+					"description": "Request to verify a verifiable credential.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
+							},
+							"examples": {
+								"identityVerifiableCredentialVerifyDocumentRequestExample": {
+									"value": {
+										"@context": [
+											"https://www.w3.org/2018/credentials/v1",
 											"https://schema.org"
 										],
 										"id": "https://example.com/credentials/3732",
@@ -3212,56 +3441,206 @@
 				}
 			}
 		},
-		"/identity/{identity}/verifiable-presentation/{verificationMethodId}": {
+		"/identity/{identity}/verifiable-presentation/{verificationMethodId}": {
+			"post": {
+				"operationId": "identityVerifiablePresentationCreate",
+				"summary": "Create an identity verifiable presentation",
+				"tags": [
+					"Identity"
+				],
+				"parameters": [
+					{
+						"name": "identity",
+						"description": "The identity to create the verification presentation for.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
+					},
+					{
+						"name": "verificationMethodId",
+						"description": "The verification method id to use.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-assertion"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to create a verifiable presentation.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/IdentityVerifiablePresentationCreateRequest"
+							},
+							"examples": {
+								"identityVerifiablePresentationCreateRequestExample": {
+									"value": {
+										"presentationId": "https://example.com/presentation/3732",
+										"verifiableCredentials": [
+											"eyJraWQiOi...D1Z3AQ"
+										]
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Response to creating a verifiable presentation.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/IdentityVerifiablePresentationCreateResponse"
+								},
+								"examples": {
+									"IIdentityVerifiablePresentationCreateResponseExample": {
+										"value": {
+											"verifiablePresentation": {
+												"@context": [
+													"https://www.w3.org/2018/credentials/v1",
+													"https://schema.org"
+												],
+												"id": "presentationId",
+												"type": [
+													"VerifiablePresentation",
+													"Person"
+												],
+												"verifiableCredential": [
+													"eyJraWQiOi...D1Z3AQ"
+												],
+												"holder": "did:entity-storage:0xcea318e06e89f3fb4048160770effd84d0cfa5801fee13dfa6f9413a00429cec"
+											},
+											"jwt": "eyJraWQiOi...D1Z3AQ"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/identity/verifiable-presentation/verify/document": {
 			"post": {
-				"operationId": "identityVerifiablePresentationCreate",
-				"summary": "Create an identity verifiable presentation",
+				"operationId": "identityVerifiablePresentationVerifyDocument",
+				"summary": "Verify an identity verifiable presentation document",
 				"tags": [
 					"Identity"
 				],
-				"parameters": [
-					{
-						"name": "identity",
-						"description": "The identity to create the verification presentation for.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
-					},
-					{
-						"name": "verificationMethodId",
-						"description": "The verification method id to use.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "my-assertion"
-					}
-				],
-				"security": [
-					{
-						"jwtBearerAuthScheme": []
-					}
-				],
 				"requestBody": {
-					"description": "Request to create a verifiable presentation.",
+					"description": "Request to verify a verifiable presentation.",
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/IdentityVerifiablePresentationCreateRequest"
+								"$ref": "https://schema.twindev.org/w3c-did/DidVerifiablePresentation"
 							},
 							"examples": {
-								"identityVerifiablePresentationCreateRequestExample": {
+								"identityVerifiablePresentationVerifyDocumentRequestExample": {
 									"value": {
-										"presentationId": "https://example.com/presentation/3732",
-										"verifiableCredentials": [
-											"eyJraWQiOi...D1Z3AQ"
+										"@context": [
+											"https://www.w3.org/2018/credentials/v1",
+											"https://schema.org"
+										],
+										"id": "https://example.com/credentials/3732",
+										"type": [
+											"VerifiableCredential",
+											"Person"
+										],
+										"verifiableCredential": [
+											{
+												"@context": [
+													"https://www.w3.org/2018/credentials/v1",
+													"https://schema.org"
+												],
+												"id": "https://example.com/credentials/3732",
+												"type": [
+													"VerifiableCredential",
+													"Person"
+												],
+												"credentialSubject": {
+													"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+													"name": "Jane Doe"
+												},
+												"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+												"issuanceDate": "2025-01-24T09:21:51.500Z",
+												"credentialStatus": {
+													"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+													"type": "BitstringStatusList",
+													"revocationBitmapIndex": "5"
+												}
+											}
 										]
 									}
 								}
@@ -3271,15 +3650,16 @@
 				},
 				"responses": {
 					"200": {
-						"description": "Response to creating a verifiable presentation.",
+						"description": "Response to verifying a verifiable presentation.",
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/IdentityVerifiablePresentationCreateResponse"
+									"$ref": "#/components/schemas/IdentityVerifiablePresentationVerifyResponse"
 								},
 								"examples": {
-									"IIdentityVerifiablePresentationCreateResponseExample": {
+									"identityVerifiablePresentationVerifyResponseExample": {
 										"value": {
+											"revoked": false,
 											"verifiablePresentation": {
 												"@context": [
 													"https://www.w3.org/2018/credentials/v1",
@@ -3294,8 +3674,7 @@
 													"eyJraWQiOi...D1Z3AQ"
 												],
 												"holder": "did:entity-storage:0xcea318e06e89f3fb4048160770effd84d0cfa5801fee13dfa6f9413a00429cec"
-											},
-											"jwt": "eyJraWQiOi...D1Z3AQ"
+											}
 										}
 									}
 								}
@@ -3323,24 +3702,6 @@
 							}
 						}
 					},
-					"401": {
-						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "UnauthorizedError",
-											"message": "errorMessage"
-										}
-									}
-								}
-							}
-						}
-					},
 					"500": {
 						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
 						"content": {
@@ -16587,24 +16948,6 @@
 											}
 										]
 									}
-								},
-								"papCreateEcosystemPolicyRequestExample": {
-									"value": {
-										"@context": [
-											"http://www.w3.org/ns/odrl.jsonld",
-											"https://schema.twindev.org/odrl/v1/"
-										],
-										"@type": "EcosystemPolicy",
-										"profile": "https://schema.twindev.org/odrl/v1/profile",
-										"assigner": "did:example:publisher",
-										"obligation": [
-											{
-												"action": "inform",
-												"assignee": "did:example:border-agency",
-												"target": "urn:twin:asset:consignment:*"
-											}
-										]
-									}
 								}
 							}
 						}
@@ -17496,123 +17839,6 @@
 				}
 			}
 		},
-		"/rights-management/policy/admin/ecosystem-policy/{id}": {
-			"get": {
-				"operationId": "papGetEcosystemPolicy",
-				"summary": "Get an ecosystem policy",
-				"tags": [
-					"Policy Administration Point"
-				],
-				"parameters": [
-					{
-						"name": "id",
-						"description": "The ID of the ecosystem policy to get.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "urn:rights-management:abc123def456"
-					}
-				],
-				"security": [
-					{
-						"jwtBearerAuthScheme": []
-					}
-				],
-				"responses": {
-					"200": {
-						"description": "The response structure for getting an ecosystem policy.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/RightsManagementEcosystemPolicy"
-								},
-								"examples": {
-									"papGetEcosystemPolicyResponseExample": {
-										"value": {
-											"@context": [
-												"http://www.w3.org/ns/odrl.jsonld",
-												"https://schema.twindev.org/odrl/v1/"
-											],
-											"@type": "EcosystemPolicy",
-											"@id": "urn:rights-management:abc123def456",
-											"profile": "https://schema.twindev.org/odrl/v1/profile",
-											"assigner": "did:example:publisher",
-											"obligation": [
-												{
-													"action": "inform",
-													"assignee": "did:example:border-agency",
-													"target": "urn:twin:asset:consignment:abc123"
-												}
-											]
-										}
-									}
-								}
-							}
-						}
-					},
-					"400": {
-						"description": "The server cannot process the request, see the content for more details.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "GeneralError",
-											"message": "errorMessage",
-											"properties": {
-												"foo": "bar"
-											}
-										}
-									}
-								}
-							}
-						}
-					},
-					"401": {
-						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "UnauthorizedError",
-											"message": "errorMessage"
-										}
-									}
-								}
-							}
-						}
-					},
-					"500": {
-						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "InternalServerError",
-											"message": "errorMessage"
-										}
-									}
-								}
-							}
-						}
-					}
-				}
-			}
-		},
 		"/rights-management/negotiations/{id}": {
 			"get": {
 				"operationId": "pnpGetNegotiation",
@@ -20183,7 +20409,7 @@
 					},
 					"message": {
 						"type": "string",
-						"description": "The message for the error."
+						"description": "The message for the error as an i18n key."
 					},
 					"source": {
 						"type": "string",
@@ -20253,43 +20479,37 @@
 				],
 				"description": "Transfer Process (DSP compliant) with current state, or error."
 			},
-			"HealthComponentInfo": {
-				"description": "The health component information.",
+			"Health": {
+				"description": "Provides health information for a component.",
 				"type": "object",
 				"properties": {
 					"name": {
 						"type": "string",
 						"description": "The name of the component."
 					},
+					"description": {
+						"type": "string",
+						"description": "The description of the component as an i18n key."
+					},
+					"isChild": {
+						"type": "boolean",
+						"description": "Whether this entry is a child of another entry, the parent entry will report the overall status of the component."
+					},
 					"status": {
 						"$ref": "#/components/schemas/HealthStatus"
 					},
 					"details": {
 						"type": "string",
-						"description": "The details for the status."
-					}
-				},
-				"required": [
-					"name",
-					"status"
-				]
-			},
-			"HealthInfo": {
-				"description": "The status of the server.",
-				"type": "object",
-				"properties": {
-					"status": {
-						"$ref": "#/components/schemas/HealthStatus"
+						"description": "The details for the status if there are further details to provide as an i18n key."
 					},
-					"components": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/HealthComponentInfo"
-						},
-						"description": "The status of the components."
+					"properties": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Properties to substitute in the i18n key for the details."
 					}
 				},
 				"required": [
+					"name",
 					"status"
 				]
 			},
@@ -20310,6 +20530,19 @@
 					}
 				]
 			},
+			"IdentityAlsoKnownAsCreateRequest": {
+				"type": "object",
+				"properties": {
+					"alias": {
+						"type": "string",
+						"description": "The alias to create for the identity."
+					}
+				},
+				"required": [
+					"alias"
+				],
+				"description": "The data for the request."
+			},
 			"IdentityCreateRequest": {
 				"type": "object",
 				"properties": {
@@ -20757,6 +20990,16 @@
 				],
 				"description": "The login response details."
 			},
+			"LogoutRequest": {
+				"type": "object",
+				"properties": {
+					"token": {
+						"type": "string",
+						"description": "The token to logout, if it uses a mechanism with public access."
+					}
+				},
+				"description": "The logout token details."
+			},
 			"MetricType": {
 				"description": "The types of metrics.",
 				"anyOf": [
@@ -21195,7 +21438,7 @@
 						"description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present."
 					},
 					"@type": {
-						"$ref": "#/components/schemas/RightsManagementPolicyType"
+						"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType"
 					},
 					"@id": {
 						"type": "string",
@@ -21267,6 +21510,10 @@
 						"type": "string",
 						"description": "The public origin of the server that initiated or received this negotiation.\nUsed to construct callback URLs in subsequent async messages."
 					},
+					"tenantId": {
+						"type": "string",
+						"description": "The tenant id this negotiation belongs to."
+					},
 					"organizationIdentity": {
 						"type": "string",
 						"description": "Organization identity to be used when sending trust payloads."
@@ -21340,6 +21587,16 @@
 					"organizationIdentity"
 				]
 			},
+			"RefreshTokenRequest": {
+				"type": "object",
+				"properties": {
+					"token": {
+						"type": "string",
+						"description": "The token to refresh, if it uses a mechanism with public access."
+					}
+				},
+				"description": "The refresh token details."
+			},
 			"RefreshTokenResponse": {
 				"type": "object",
 				"properties": {
@@ -21364,223 +21621,8 @@
 				],
 				"description": "Transfer Process (DSP compliant) with state REQUESTED, or error."
 			},
-			"RightsManagementEcosystemPolicy": {
-				"description": "TWIN EcosystemPolicy in DSP storage shape.\n\nCombines the DSP wire-format requirements (mandatory `@id`, no `uid`) from\n`IDataspaceProtocolPolicy` with a narrowed `@type` discriminant so that callers\ncan rely on the type at compile time without any `as unknown as` cast.\n\nDefined as an intersection type (rather than `extends IDataspaceProtocolPolicy`)\nso that the narrowed `\"@type\": \"EcosystemPolicy\"` can override the base\n`\"@type\": OdrlPolicyType` without a TS2430 extends-incompatibility error.\n`\"EcosystemPolicy\"` is a TWIN extension — not in the W3C ODRL `OdrlPolicyType`\nenum — so the interface hierarchy cannot express this narrowing directly.\n\nLives in `rights-management-models` (not `standards-dataspace-protocol`) because\nEcosystemPolicy is a TWIN platform extension — not a DSP specification concept —\nand `standards-dataspace-protocol` should remain a pure standards mirror.",
-				"type": "object",
-				"properties": {
-					"@context": {
-						"$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType"
-					},
-					"profile": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "array",
-								"items": {
-									"type": "string"
-								}
-							}
-						],
-						"description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s)."
-					},
-					"assigner": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"type": "string"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
-										}
-									]
-								}
-							}
-						],
-						"description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level."
-					},
-					"assignee": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"type": "string"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
-										}
-									]
-								}
-							}
-						],
-						"description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level."
-					},
-					"target": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"type": "string"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
-										}
-									]
-								}
-							}
-						],
-						"description": "The target asset for the rule."
-					},
-					"action": {
-						"anyOf": [
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
-							},
-							{
-								"type": "string"
-							},
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
-										},
-										{
-											"type": "string"
-										},
-										{
-											"$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
-										}
-									]
-								}
-							}
-						],
-						"description": "The action associated with the rule."
-					},
-					"inheritFrom": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "array",
-								"items": {
-									"type": "string"
-								}
-							}
-						],
-						"description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies)."
-					},
-					"conflict": {
-						"$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType"
-					},
-					"permission": {
-						"anyOf": [
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
-								}
-							}
-						],
-						"description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
-					},
-					"prohibition": {
-						"anyOf": [
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
-								}
-							}
-						],
-						"description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
-					},
-					"obligation": {
-						"anyOf": [
-							{
-								"$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
-								}
-							}
-						],
-						"description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present."
-					},
-					"@id": {
-						"type": "string",
-						"description": "Unique identifier for the policy."
-					},
-					"@type": {
-						"const": "EcosystemPolicy",
-						"description": "The type must be \"EcosystemPolicy\"."
-					}
-				},
-				"required": [
-					"@context",
-					"@id",
-					"@type"
-				]
-			},
 			"RightsManagementPolicy": {
-				"description": "Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.\n\nDefined as an intersection type (rather than `extends IDataspaceProtocolPolicy`)\nbecause `IDataspaceProtocolPolicy[\"@type\"]` is constrained to `OdrlPolicyType`\n(the closed W3C ODRL enum). TWIN adds `\"EcosystemPolicy\"` as a platform extension\nvia `RightsManagementPolicyType`, which is a superset of `OdrlPolicyType`.\n\nAll standard DSP policy types (`IDataspaceProtocolAgreement`, `IDataspaceProtocolOffer`,\n`IDataspaceProtocolSet`) remain structurally assignable to this type because their\n`\"@type\"` literals are all members of `RightsManagementPolicyType`.\n\nUse this type wherever the PAP needs to accept or return any policy regardless of\nits specific subtype. Use the narrower `IRightsManagementEcosystemPolicy`,\n`IDataspaceProtocolAgreement`, etc. when the specific subtype is known.",
+				"description": "Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.",
 				"type": "object",
 				"properties": {
 					"@context": {
@@ -21784,7 +21826,7 @@
 						"description": "Unique identifier for the policy."
 					},
 					"@type": {
-						"$ref": "#/components/schemas/RightsManagementPolicyType"
+						"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType"
 					}
 				},
 				"required": [
@@ -21793,27 +21835,6 @@
 					"@type"
 				]
 			},
-			"RightsManagementPolicyType": {
-				"description": "TWIN rights-management policy types.",
-				"anyOf": [
-					{
-						"const": "EcosystemPolicy",
-						"description": "EcosystemPolicy type.\nA TWIN platform-level governance policy that carries obligations for data events.\nNot a bilateral contract — does not participate in DSP negotiation."
-					},
-					{
-						"const": "Policy"
-					},
-					{
-						"const": "Set"
-					},
-					{
-						"const": "Offer"
-					},
-					{
-						"const": "Agreement"
-					}
-				]
-			},
 			"Rule": {
 				"description": "Rule defining how to extract data from an object.",
 				"type": "object",
@@ -21872,6 +21893,25 @@
 				},
 				"description": "The favicon for the server."
 			},
+			"ServerHealthResponse": {
+				"type": "object",
+				"properties": {
+					"status": {
+						"$ref": "#/components/schemas/HealthStatus"
+					},
+					"components": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/Health"
+						}
+					}
+				},
+				"required": [
+					"status",
+					"components"
+				],
+				"description": "The health for the server."
+			},
 			"ServerInfo": {
 				"description": "The information about the server.",
 				"type": "object",
@@ -21893,17 +21933,24 @@
 			"ServerLivezResponse": {
 				"anyOf": [
 					{
-						"const": "ok"
+						"const": "alive"
 					},
 					{
-						"const": "failed"
+						"const": "dead"
 					}
 				],
 				"description": "The livez information for the server."
 			},
-			"ServerRootResponse": {
-				"type": "string",
-				"description": "The root text for the server."
+			"ServerReadyzResponse": {
+				"anyOf": [
+					{
+						"const": "ready"
+					},
+					{
+						"const": "not ready"
+					}
+				],
+				"description": "The readyz information for the server."
 			},
 			"ServerSpecResponse": {
 				"description": "The spec for the server."