GET
https://api.myidvirtual.com
/
openapi
Get OpenAPI Specification
curl --request GET \
  --url https://api.myidvirtual.com/openapi
{
  "openapi": "<string>",
  "info": {},
  "paths": {},
  "components": {}
}

​
Description

This endpoint returns the complete OpenAPI specification document that describes all available API endpoints, request/response schemas, and authentication methods.

​
Response

​
openapi
string
OpenAPI specification version
​
info
object
API metadata including title, description, and version
​
paths
object
All available API endpoints with their operations
​
components
object
Reusable schemas, parameters, and security schemes

​
Example Request

curl -X GET "http://localhost:3333/openapi"

​
Response Example

{
  "openapi": "3.0.0",
  "info": {
    "title": "My ID Virtual API",
    "description": "API documentation for My ID Virtual platform",
    "version": "1.0.0"
  },
  "paths": {
    "/auth/signin": {
      "post": { ... }
    },
    ...
  },
  "components": {
    "schemas": { ... },
    "securitySchemes": { ... }
  }
}

​
Usage

This endpoint is primarily used by documentation tools like Swagger UI, Mintlify, or other API documentation platforms to automatically generate interactive API documentation.