Files
Goa-gel-fullstack/Documentation/developers/index.md
Mahi 6ec8d3236d feat: Rebrand to License Authority with Govt of Goa branding
- Replace TLAS with License Authority throughout documentation
- Add Government of Goa emblem/logo (Ashoka Chakra style)
- Update frontend branding to match documentation
- Add configurable Swagger API link via VITE_API_BASE_URL env var
- Fix Docker build for VitePress (git dependency, .dockerignore)
- Fix helmet security headers for HTTP deployments
- Add CORS support for VM deployment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-10 00:46:25 -04:00

2.6 KiB

API Documentation

Overview

The platform provides REST APIs for integrating with external systems. All APIs use JSON for request and response bodies.

Base URL

Production: https://api.license.gov.in/v1
Staging:    https://api-staging.license.gov.in/v1

Interactive API Documentation

Explore and test APIs using our interactive Swagger UI:

The Swagger documentation provides:

  • Complete endpoint specifications
  • Request/response schemas
  • Interactive "Try it out" functionality
  • Authentication testing

Authentication

All API requests require authentication via Bearer token.

Authorization: Bearer <access_token>

Obtain tokens through the authentication endpoint. See Authentication for details.

Request Format

POST /applications HTTP/1.1
Host: api.license.gov.in
Authorization: Bearer eyJhbGc...
Content-Type: application/json

{
  "licenseType": "TRADE_LICENSE",
  "applicantId": "12345",
  "data": { ... }
}

Response Format

Success Response

{
  "success": true,
  "data": {
    "id": "APP-2026-00001",
    "status": "SUBMITTED"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid license type",
    "details": [
      { "field": "licenseType", "message": "Must be one of: TRADE_LICENSE, FOOD_LICENSE" }
    ]
  }
}

Rate Limits

Tier Requests/minute Burst
Standard 60 100
Premium 300 500

Rate limit headers included in all responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1707500000

API Endpoints

Category Endpoint Description
Auth POST /auth/token Obtain access token
Applications POST /applications Submit new application
Applications GET /applications/:id Get application status
Documents POST /documents/upload Upload document
Verification GET /verify/:tokenId Verify certificate

SDKs

Official SDKs available:

  • JavaScript/TypeScript: npm install @license-authority/sdk
  • Python: pip install license-authority-sdk
  • Java: Maven artifact gov.in.license:license-authority-sdk

Documentation