digifi-BankToProductCore/app/swagger/digifi_swagger.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Swagger Simbrella Core [10/22/2025] - OpenAPI 3.0",
    "description": "This is a Simbrella FirstAdvance Backend Server with the OpenAPI 3.0 specification.  \n\n\nSome useful links:\n- [Web Simulated Demo Page](https://digifi-salaryloan.chiefsoft.net/)\n- [Web Management Support Portal](https://digifi-office.chiefsoft.net/auth/login)",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "email": "support@chiefsoft.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.11"
  },
  "servers": [
    {
      "url": "http://localhost:4500"
    },
    {
      "url": "http://api.dev.simbrellang.net:4500"
    },
    {
      "url": "https://api.dev.simbrellang.net"
    },
    {
      "url": "http://10.2.249.133:4500"
    }
  ],
  "tags": [
    {
      "name": "Health",
      "description": "System health check including DB status."
    },
    {
      "name": "Authorize",
      "description": "This feature will be used for authorizing customers.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "AuthorizeRefresh",
      "description": "This feature will be used for refreshing authorized customers.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "EligibilityCheck",
      "description": "Eligibility Check Request",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "SelectOffer",
      "description": "This method is used the send the offer the customer selected to Simbrella.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "ProvideLoan",
      "description": "Provide Loan Request.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "LoanStatus",
      "description": "Loan Information Request.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    },
    {
      "name": "Repayment",
      "description": "Repayment Request.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://www.simbrellang.net"
      }
    }
  ],
  "paths": {
    "/health": {
      "get": {
        "tags": ["Health"],
        "summary": "Health Check",
        "description": "Returns service health information including DB connection status.",
        "responses": {
          "200": {
            "description": "Health check successful",
            "content": {
              "application/json": {
                "example": {
                  "status": "ok",
                  "db_status": "Connection Successful",
                  "events_service_status":"Connection Successful",
                  "emulator_status":"Connection Successful",
                  "db_uri": "postgresql://user:****@localhost:5432/digifi_db",
                  "error": []
                }
              }
            }
          },
          "500": {
            "description": "Health check failed",
            "content": {
              "application/json": {
                "example": {
                  "status": "failed",
                  "db_status": "Connection Failed",
                  "events_service_status":"Connection Failed",
                  "emulator_status":"Connection Failed",
                  "db_uri": "Unavailable",
                  "error":["could not connect to server: Connection refused"]
                }
              }
            }
          }
        }
      }
    },
    "/Authorize": {
      "$ref": "swagger/paths/Authorize.json"
    },
    "/AuthorizeRefresh": {
      "$ref": "swagger/paths/AuthorizeRefresh.json"
    },
    "/EligibilityCheck": {
      "$ref": "swagger/paths/EligibilityCheck.json"
    },
    "/SelectOffer": {
      "$ref": "swagger/paths/SelectOffer.json"
    },
    "/ProvideLoan": {
      "$ref": "swagger/paths/ProvideLoan.json"
    },
    "/LoanStatus": {
      "$ref": "swagger/paths/LoanStatus.json"
    },
    "/Repayment": {
      "$ref": "swagger/paths/Repayment.json"
    }
  },
  "components": {
    "schemas": {
      "EligibilityCheckRequest": {
        "$ref": "swagger/schemas/EligibilityCheckRequest.json"
      },
      "EligibilityCheckResponse": {
        "$ref": "swagger/schemas/EligibilityCheckResponse.json"
      },
      "SelectOfferRequest": {
        "$ref": "swagger/schemas/SelectOfferRequest.json"
      },
      "SelectOfferResponse": {
        "$ref": "swagger/schemas/SelectOfferResponse.json"
      },
      "LoanStatusRequest": {
        "$ref": "swagger/schemas/LoanStatusRequest.json"
      },
      "LoanStatusResponse": {
        "$ref": "swagger/schemas/LoanStatusResponse.json"
      },
      "RepaymentRequest": {
        "$ref": "swagger/schemas/RepaymentRequest.json"
      },
      "RepaymentResponse": {
        "$ref": "swagger/schemas/RepaymentResponse.json"
      },
      "ApiResponse": {
        "$ref": "swagger/schemas/ApiResponse.json"
      },
      "AuthorizeResponse": {
        "$ref": "swagger/schemas/AuthorizeResponse.json"
      },
      "AuthorizeRequest": {
        "$ref": "swagger/schemas/AuthorizeRequest.json"
      },
      "AuthorizeRefreshResponse": {
        "$ref": "swagger/schemas/AuthorizeRefreshResponse.json"
      },
      "AuthorizeRefreshRequest": {
        "$ref": "swagger/schemas/AuthorizeRefreshRequest.json"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "basicAuth": [],
      "bearerAuth": []
    }
  ]
}