Nodex (3.1.1)

Download OpenAPI specification:Download

Create a DID

Example Code Links (GitHub)

Python

Node.js

Responses

Response samples

200
500

Content type

application/json

{"@context": ["https://www.w3.org/ns/did/v1"
],
"id": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"verificationMethod": [{"id": "#signingKey",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "EC",
"crv": "secp256k1",
"x": "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6Q7r8S9t0U1v",
"y": "Z9y8X7w6V5u4T3s2R1q0P9o8N7m6L5k4J3i2H1g0F9e"
}
},
{"id": "#encryptionKey",
"type": "X25519KeyAgreementKey2019",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "OKP",
"crv": "X25519",
"x": "X1Y2Z3A4B5C6D7E8F9G0H1I2J3K4L5M6N7O8P9Q0R1S"
}
},
{"id": "#signTimeSeriesKey",
"type": "Ed25519VerificationKey2018",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "OKP",
"crv": "Ed25519",
"x": "Ed25519_Example_Key_Value_ABC123DEF456GHI789"
}
}
]
}

Get a DID

Example Code Links (GitHub)

Python

Responses

Response samples

200
500

Content type

application/json

{"@context": ["https://www.w3.org/ns/did/v1"
],
"id": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"verificationMethod": [{"id": "#signingKey",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "EC",
"crv": "secp256k1",
"x": "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6Q7r8S9t0U1v",
"y": "Z9y8X7w6V5u4T3s2R1q0P9o8N7m6L5k4J3i2H1g0F9e"
}
},
{"id": "#encryptionKey",
"type": "X25519KeyAgreementKey2019",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "OKP",
"crv": "X25519",
"x": "X1Y2Z3A4B5C6D7E8F9G0H1I2J3K4L5M6N7O8P9Q0R1S"
}
},
{"id": "#signTimeSeriesKey",
"type": "Ed25519VerificationKey2018",
"controller": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"publicKeyJwk": {"kty": "OKP",
"crv": "Ed25519",
"x": "Ed25519_Example_Key_Value_ABC123DEF456GHI789"
}
}
]
}

Create a didcomm message

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

destination-did required	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"destination-did": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
"message": {"string": "test-string",
"number": 12.34,
"boolean": true,
"array": ["test-array"
],
"map": {"property1": "test-map",
"property2": "test-map"
}
}
}

Response samples

Content type

application/json

{"ciphertext": "mWtb1lJCP...",
"iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
"protected": "eyJ0eXAiOi...",
"recipients": [{"encrypted_key": "yvf2zH03Oga8vzft9e09Jx8aRyntZo--YEoFAMYX61o",
"header": {"alg": "ECDH-1PU+XC20PKW",
"epk": {"crv": "X25519",
"kty": "OKP",
"x": "uTffeZO8cy7CGmxgn1rIsY-O6D6lfYMj8VQclxdwbBE"
},
"iv": "1F-YLXVc0kVVwRp81hVjrwDDqDFutISc",
"key_ops": [""
],
"kid": "",
"tag": "_vTP_tNvSj32jOumcSUk6Q"
}
}
],
"tag": "uasZqeLyqI9kPObyHSFzeA"
}

Verify a didcomm message

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

ciphertext	string
iv	string
protected	string
	Array of objects
tag	string

Responses

Request samples

Payload

Content type

application/json

{"ciphertext": "mWtb1lJCP...",
"iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
"protected": "eyJ0eXAiOi...",
"recipients": [{"encrypted_key": "yvf2zH03Oga8vzft9e09Jx8aRyntZo--YEoFAMYX61o",
"header": {"alg": "ECDH-1PU+XC20PKW",
"epk": {"crv": "X25519",
"kty": "OKP",
"x": "uTffeZO8cy7CGmxgn1rIsY-O6D6lfYMj8VQclxdwbBE"
},
"iv": "1F-YLXVc0kVVwRp81hVjrwDDqDFutISc",
"key_ops": [""
],
"kid": "",
"tag": "_vTP_tNvSj32jOumcSUk6Q"
}
}
],
"tag": "uasZqeLyqI9kPObyHSFzeA"
}

Response samples

Content type

application/json

{"created_at": "2025-05-29T12:34:56.789012345+00:00",
"message_id": "12345678-abcd-ef01-2345-6789abcdef01",
"payload": "{\"message\": {\"string\": \"example_value\", \"number\": 42, \"boolean\": false, \"array\": [\"alpha\", \"beta\", \"gamma\"], \"map\": {\"sample_key\": \"sample_value\"}}}"
}

Create a event

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

Array

key required	string (Key)
detail required	string (Detail) <= 255 characters
occurred_at required	number <date-time> (Occurred At)

Responses

Request samples

Payload

Content type

application/json

[{"key": "test-key",
"detail": "test-detail",
"occurred_at": 1732714444204
}
]

Response samples

400
500

Content type

application/json

{"code": 1111,
"message": "key is required"
}

Create a custom metric

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

Array

key required	string (Key)
value required	number <float> (Value)
occurred_at required	number <date-time> (Occurred At)

Responses

Request samples

Payload

Content type

application/json

[{"key": "test-key",
"value": 12.34,
"occurred_at": 1732714444204
}
]

Response samples

400
500

Content type

application/json

{"code": 1111,
"message": "key is required"
}

Create a log

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

Array

message required	string (Message) <= 1048576 characters
occurred_at required	number <date-time> (Occurred At)

Responses

Request samples

Payload

Content type

application/json

[{"message": "test-message",
"occurred_at": 1732714444204
}
]

Response samples

400
500

Content type

application/json

{"code": 1111,
"message": "message is required"
}

Create an attribute

Example Code Links (GitHub)

Python

Node.js

Request Body schema: application/json
required

key_name required	string (Key name)
value required	string (Value)

Responses

Request samples

Payload

Content type

application/json

{"key_name": "test-key-name",
"value": "test-value"
}

Response samples

400
500

Content type

application/json

{"code": 1111,
"message": "key_name is required"
}

Nodex (3.1.1)

Create a DID

Example Code Links (GitHub)

Responses

Response samples

Get a DID

Example Code Links (GitHub)

Responses

Response samples

Create a didcomm message

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify a didcomm message

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a event

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a custom metric

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a log

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create an attribute

Example Code Links (GitHub)

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required