Agent

OpenAPI documentation for the "Agen" module

This endpoint facilitates the retrieval of a DID document id.

GET../public/did

Response

200503

Body

text/plain

any

Request

JavaScriptCurlPython

const response = await fetch('../public/did', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Returns all the information needed to see the status of the services running

GET../public/getStatus

Response

200503

Body

application/json

state*enum

What state is the Agent in

startingrunningdid_resolving

did*GetStatusDidDto (object)

started*string

Agent started date with timestamp in ISO

Example: "2011-10-05T14:48:00.000Z"

timestamp*string

Current date with timestamp in ISO

Example: "2011-10-05T14:48:00.000Z"

version*GetStatusVersionDto (object)

Request

JavaScriptCurlPython

const response = await fetch('../public/getStatus', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "state": "starting",
  "did": {
    "did": "did:bsv:1234",
    "ready": true,
    "controller": "https://did.identity.controller.nchainplatform.com/",
    "resolver": "https://did.identity.resolver.nchainplatform.com/"
  },
  "started": "2011-10-05T14:48:00.000Z",
  "timestamp": "2011-10-05T14:48:00.000Z",
  "version": {
    "version": "v1.1.0",
    "commit": "4bfccdd063f6d21d34beba1c48eb6e82170d99f0",
    "development": true,
    "buildTime": "2011-10-05T14:48:00.000Z"
  }
}