Utilities

Check health of endpoint

get

Check if the endpoint is healthy and well

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

stringOptional

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get/health-check

GET /api/health-check HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Deep health check (exercises DIDKit end to end)

get

Issues and verifies a test credential + presentation with the service keypair, proving the full DIDKit crypto path (plugin load, signing, and the runtime delegation inside the native plugin) works. Reports which DIDKit engine loaded. Added after the 2026-07-02 incidents, where shallow health checks stayed green while DIDKit paths were broken.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

healthybooleanRequired

versionstringRequired

didkitEnginestring · enumRequiredPossible values:

didstringRequired

vpVerifiedbooleanRequired

verificationErrorsstring[]Required

msnumberRequired

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get/health-check/deep

GET /api/health-check/deep HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "healthy": true,
  "version": "text",
  "didkitEngine": "native",
  "did": "text",
  "vpVerified": true,
  "verificationErrors": [
    "text"
  ],
  "ms": 1
}

Request a list of valid challenges

get

Generates an arbitrary number of valid challenges for a did, then returns them

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

amountinteger · max: 100OptionalDefault: 100

Responses

200

Successful response

application/json

string[]Optional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/challenges

GET /api/challenges HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Get LCN Did

get

Gets the did:web for the LearnCloud itself

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

stringOptional

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get/did

GET /api/did HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text