cs-visual-time-sapi-v2 icon

cs-visual-time-sapi-v2

1.0.x
(0 reviews)
System API for interacting with Visual Time services. Supports payment processing, policy issuance, insured data management, and benefit updates within institutional insurance workflows.

🏠 Home - 🧾 cs-visual-time-sapi-v2

The cs-visual-time-sapi-v2 API is a System API that interfaces directly with the VisualTIME API or its underlying database, enabling key operations such as insured value updates, policy issuance, payment processing, and beneficiary management.

This API serves as a crucial backend connector for VisualTIME functionalities in institutional insurance flows.

🌐 Basic Information

  • API Title: cs-visual-time-sapi-v2
  • Version: 1.0.0
  • Base URL: https://cs-visual-time-sapi-{env}-v2.us-e1.cloudhub.io/api/
  • Environments:
    • dev
    • qa
    • prod

🚀 How to Get Started

  1. Authentication:You must include a valid client_id and an OAuth 2.0 Bearer token to authenticate all API requests.
  2. Base URL Usage:Use the Base URL above as the root for all endpoints. Replace {env} with your current environment (e.g., dev, qa, prod).
  3. Headers:Add the following headers to each API call:H "client_id: YOUR_CLIENT_ID"H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📍 Available Endpoints

📌 Endpoints Overview

MethodEndpointDescriptionExchange Link
GET/send-payments-ordersRetrieve payment orders marked to be sentView Details
POST/receive-payments-ordersReceives final result of payment orders from virtual walletsView Details
POST/quoting/issuing-of-policyGet insurance quote and issue a policyView Details
GET/quoting/release-or-issuance-of-PolicyRelease or issue a policyView Details
POST/creation-of-insured-personsInclude insured individuals in institutional policiesView Details
PUT/update-of-insured-amountsUpdate insured capital amountsView Details
PUT/client-newnessUpdate insured, dependent, and beneficiary dataView Details
GET/obtain-information/modulebysalechannelQuery payment frequency configuration by sales channelView Details
PUT/update-modulebysalechannelUpdate payment frequency status in modulesView Details
POST/addRemoveDependentInsuredsAdd or remove dependent insured individualsView Details
PUT/updatePolicyBeneficiariesUpdate beneficiary information on a policyView Details

⚠️ Error Handling

The API uses standard HTTP response codes to indicate the success or failure of requests:

  • 200 OK – Request succeeded
  • 400 Bad Request – Input validation error
  • 401 Unauthorized – Authentication failed
  • 404 Not Found – The requested resource was not found
  • 500 Internal Server Error – Unexpected server-side error

📞 Support

For any issues, please contact the API support team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

Reviews