Agent

OpenAPI documentation for the Agent module

get

This endpoint facilitates the retrieval of a DID document id.

Responses

text/plain

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../public/did'

200

503

200

did:bsv:1234

get

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../public/getStatus'

200

503

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"
  }
}

Retrieve information about credential types and configurations

get

Endpoint facilitates the retrieval of a list of credentials that can be issued based on the provided correlationId. This endpoint expects the correlationId to be passed as a path parameter. Upon receiving a request, the server searches for JSON files located in the /dev/oid4vci_metadata directory, matching the correlationId with the correlationId property in the JSON files. It also returns metadata, which has fields credential_issuer (tells web address where issuer is located) and credential_endpoint (tells web address endpoint where credential can be claimed). It also returns display object and credential_supplier_configobject. display field name will be displayed in wallet app as Authority Name when accepting a credential. Object credential_supplier_config returns all templates and mappings for the credential supplier.

Path parameters

correlationIdstringrequired

The correlation ID defined on the server (nchain in our case).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../public/{correlationId}/.well-known/openid-credential-issuer'

200

503

200

{
  "credential_issuer": "text",
  "credential_endpoint": "text",
  "display": {
    "name": "Organisation Issuer",
    "description": "Organisation Issuer"
  },
  "credentials_supported": [
    {
      "display": {
        "name": "Email Credential",
        "description": "Email Credential for Organisation"
      },
      "order": [
        "name-of-claim"
      ],
      "credentialSubject": {
        "name-of-claim": "value"
      }
    }
  ]
}