Setup your development

Learn how to update your docs locally and deploy them to the public.

Getting Started

To get started with the My ID Virtual API, you’ll need:
  1. An API key from your dashboard
  2. Base URL: http://localhost:3333
  3. Authentication via Bearer token

Making your first request

curl -X GET "http://localhost:3333/auth/me" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

Preview documentation locally

To preview the documentation locally:
# Install Mintlify CLI
npm i -g mintlify

# Run development server
mintlify dev
A local preview will be available at http://localhost:3000.

API Reference

All API endpoints are automatically documented through OpenAPI/Swagger:
  • OpenAPI JSON: http://localhost:3333/openapi
  • Swagger UI: http://localhost:3333/swagger
  • Scalar UI: http://localhost:3333/docs
The API reference in this documentation is automatically generated from your OpenAPI specification.