Museum logo
API docs by Redocly

Nodex (3.1.1)

Download OpenAPI specification:Download

Create a DID

Python

Node.js

Responses

Response samples

Content type
application/json
{
  • "@context": "https://www.w3.org/ns/did-resolution/v1",
  • "didDocument": {
    },
  • "methodMetadata": {
    }
}

Get a DID

Python

Node.js

Responses

Response samples

Content type
application/json
{
  • "@context": "https://www.w3.org/ns/did-resolution/v1",
  • "didDocument": {
    },
  • "methodMetadata": {
    }
}

Create a didcomm message

Python

Node.js

Request Body schema: application/json
required
destination-did
required
string
required
object
operation-tag
required
string

Responses

Request samples

Content type
application/json
{
  • "destination-did": "did:nodex:test:EiCs3BugA0NwXA-Umdv56h7ouoYCxzQ3PLFEm_aGjvmEYQ",
  • "message": {
    },
  • "operation-tag": "test-operation-tag"
}

Response samples

Content type
application/json
{
  • "ciphertext": "mWtb1lJCP...",
  • "iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
  • "protected": "eyJ0eXAiOi...",
  • "recipients": [
    ],
  • "tag": "uasZqeLyqI9kPObyHSFzeA"
}

Verify a didcomm message

Python

Node.js

Request Body schema: application/json
required
ciphertext
string
iv
string
protected
string
Array of objects
tag
string

Responses

Request samples

Content type
application/json
{
  • "ciphertext": "mWtb1lJCP...",
  • "iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
  • "protected": "eyJ0eXAiOi...",
  • "recipients": [
    ],
  • "tag": "uasZqeLyqI9kPObyHSFzeA"
}

Response samples

Content type
application/json
{
  • "issuer": {
    },
  • "issuanceDate": "2024-09-19T00:02:14.189033Z",
  • "@context": [],
  • "type": [
    ],
  • "credentialSubject": {
    },
  • "proof": {
    }
}

Create a verifiable message

Python

Node.js

Request Body schema: application/json
required
destination-did
required
string
required
object
operation-tag
required
string

Responses

Request samples

Content type
application/json
{
  • "destination-did": "did:nodex:test:EiCs3BugA0NwXA-Umdv56h7ouoYCxzQ3PLFEm_aGjvmEYQ",
  • "message": {
    },
  • "operation-tag": "test-operation-tag"
}

Response samples

Content type
application/json
{
  • "issuer": {
    },
  • "issuanceDate": "2024-09-19T00:02:14.189033Z",
  • "@context": [],
  • "type": [
    ],
  • "credentialSubject": {
    },
  • "proof": {
    }
}

Veify a verifiable message

Python

Node.js

Request Body schema: application/json
required
object
issuanceDate
string <date-time>
@context
Array of strings
type
Array of strings
object
object

Responses

Request samples

Content type
application/json
{
  • "issuer": {
    },
  • "issuanceDate": "2024-09-19T00:02:14.189033Z",
  • "@context": [],
  • "type": [
    ],
  • "credentialSubject": {
    },
  • "proof": {
    }
}

Response samples

Content type
application/json
{
  • "issuer": {
    },
  • "issuanceDate": "2024-09-19T00:02:14.189033Z",
  • "@context": [],
  • "type": [
    ],
  • "credentialSubject": {
    },
  • "proof": {
    }
}

Create a event

Python

Node.js

Request Body schema: application/json
required
key
required
string (Key)
detail
required
string (Detail) <= 255 characters
occurred_at
required
number <date-time> (Occurred At)

Responses

Request samples

Content type
application/json
{
  • "key": "test-key",
  • "detail": "test-detail",
  • "occurred_at": 1732714444204
}

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key is required"
}

Create a custom metric

Python

Node.js

Request Body schema: application/json
required
key
required
string (Key)
value
required
number <float> (Value)
occurred_at
required
number <date-time> (Occurred At)

Responses

Request samples

Content type
application/json
{
  • "key": "test-key",
  • "value": 12.34,
  • "occurred_at": 1732714444204
}

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key is required"
}

Create an attribute

Python

Node.js

Request Body schema: application/json
required
key_name
required
string (Key name)
value
required
string (Value)

Responses

Request samples

Content type
application/json
{
  • "key_name": "test-key-name",
  • "value": "test-value"
}

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key_name is required"
}