API reference

Vitni exposes a versioned REST API under /api/v1. The NestJS app generates an OpenAPI document and serves an interactive API reference at /api/v1/openapi when the API is running.

Open the local API reference

Start the local environment using Local development, then open:

http://127.0.0.1:14000/api/v1/openapi

The browser workspace uses a same-origin backend-for-frontend proxy for authenticated requests. Direct API access is intended for integrations and local development; endpoints enforce authentication, organization membership, and role checks.

API areas

The current API includes authenticated routes for organizations, issuer profiles and branding, members and invitations, achievement authoring, pathway authoring, credential issuance with optional signed evidence, correction, renewal and revocation, holder claims, and organization analytics with CSV export. Public routes serve issuer, issuer presentation settings, achievement, credential, pathway, and status-list documents. POST /api/v1/verify checks a Vitni or external Open Badges credential. Signed-in recipients can retrieve their claimed-credential progress for public pathways.

Use the generated OpenAPI description as the exact current route and request contract. APIs for unfinished parity features—such as endorsements, webhooks, scheduled issuance, and operator administration—are not available yet.