API Reference

Health Check

get

Health-check endpoint.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Responses

200

Successful Response

application/json

anyOptional

get

/health

HTTPcURLJavaScriptPython

GET /health HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content

Version Check

get

Version endpoint.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Responses

200

Successful Response

application/json

anyOptional

get

/version

HTTPcURLJavaScriptPython

GET /version HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content