Skip to content
Authrim

Return VC Worker health.

GET
/api/health
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/health

Responses

Section titled “ Responses ”

200

Section titled “200 ”

VC Worker health response.

Media type application/json
object
status
required
string
Allowed values: ok
service
required
string
components
required
Array<string>
timestamp
required
string format: date-time
Example 
{
  "status": "ok",
  "service": "ar-vc",
  "components": [
    "verifier",
    "issuer",
    "did"
  ],
  "timestamp": "2026-02-03T04:05:06.000Z"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
required
string
error_description
required
string
Example 
{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
required
string
error_description
required
string
Example 
{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}