cs-visual-time-banca-seguros-sapi icon

cs-visual-time-banca-seguros-sapi

1.0.x
(0 reviews)
System API that interacts directly with Visual Time API or BD system, specialized in policy issuance, quotations, claims management, and PostgreSQL operations for the banking insurance sector.

🏦 Home - 💼 cs-visual-time-banca-seguros-sapi

The cs-visual-time-banca-seguros-sapi API is a System API that interacts directly with Visual Time API or BD system, specialized in policy issuance, quotations, claims management, and PostgreSQL operations for the banking insurance sector.

This API serves as a fundamental connector for Visual Time functionalities, allowing integration with various internal systems and providing access to critical insurance business operations.

🌐 Basic Information

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

🚀 How to Get Started

  1. Authentication: You must include a valid client_id to authenticate all API requests using the client-id-enforcement and OAuth2 security schemes.
  2. Base URL Usage: Use the Base URL above as the root for all endpoints.
  3. Headers: All endpoints require common request headers as defined in the API specification.

📍 Available Endpoints

📌 Endpoints Overview

MethodEndpointDescriptionExchange Link
GET/issuing-of-policy-statusGet policy issuance statusView Details
GET/issuing-of-policy-range-hourQuery policy issuance by hour rangeView Details
PUT/issuing-of-policy-updateUpdate policy issuance recordsView Details
DELETE/issuing-of-policy-remove-registryRemove policy issuance recordsView Details
POST/issuing-of-policy-get-documentNumberGet document number for policy issuanceView Details
POST/issuing-of-policy-post-create-policy-to-reinject-dbCreate policy to reinject into databaseView Details
GET/claim/coverage-affectedGet coverage affected by claimView Details
GET/quoting/issuing-of-policy-statusPolicy issuance status for quotationsView Details
GET/quoting/issuing-of-policy-range-hourHour range for quotationsView Details
PUT/quoting/issuing-of-policy-updateUpdate policy issuance in quotationsView Details
DELETE/cancel-issuing-of-policyCancel policy issuanceView Details
POST/cancellation-of-policiesRemove cancelled policy recordsView Details
GET/vt-policy-assigner-canceled-range-datetimeQuery cancelled policies by date rangeView Details
PUT/update-policy-assigner-set-issuedUpdate policy assigner as issuedView Details
POST/execute-queryExecute custom queryView Details
POST/posgresql/issuing-of-policy-assigned-number-quotingAssign policy number for quotationView Details
POST/posgresql/policy-assigner-quotingPolicy assigner for quotationView Details
PUT/posgresql/releaseOrIssuanceOfPolicyRelease or issue policyView Details
PUT/posgresql/updateModulebysalechannelUpdate module by sales channelView Details
GET/posgresql/obtainInformation-modulebysalechannelGet module information by sales channelView Details
POST/posgresql/creation-of-insured-personsCreate insured personsView Details
POST/retrivePolicyLifeIssueMatrizRetrieve policy life issue matrixView Details

🎯 Main Functionalities

📄 Policy Issuance

Complete management of the policy issuance lifecycle, including:

  • Query issuance status
  • Update records
  • Remove records
  • Get document numbers
  • Create policies for database reinjection

💰 Quotations

Specific operations for the quotation process:

  • Issuance status for quotations
  • Time-range queries
  • Issuance updates in quotation process

⚠️ Claims

Claims and coverage management:

  • Query coverage affected by claim number
  • Detailed information by policy number

❌ Cancellations

Policy cancellation handling:

  • Cancel policy issuance
  • Remove cancelled policy records
  • Query cancelled policies by date ranges

🗄️ PostgreSQL Operations

Direct interactions with PostgreSQL database:

  • Policy number assignment
  • Policy release and issuance
  • Sales channel module management
  • Insured persons creation
  • Custom queries

🔧 Utilities

Support tools and functions:

  • Execute custom queries
  • Update policy assigners
  • Retrieve issuance matrices

🌍 Environments and URLs

Development

https://cs-visual-time-banca-seguros-sapi-dev-v1.us-e1.cloudhub.io/api/

QA

https://cs-visual-time-banca-seguros-sapi-qa-v1.us-e1.cloudhub.io/api/

Production

https://cs-visual-time-banca-seguros-sapi-prod-v1.us-e1.cloudhub.io/api/

⚠️ 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

The API implements common HTTP error code handling as indicated in the RAML specification.

🔒 Security

  • Client ID Enforcement: All requests require a valid client_id
  • OAuth2: OAuth2 authentication implementation for secure access
  • HTTPS: All communications must be done through HTTPS

📊 Common Parameters

Frequent Query Parameters:

  • productId - Product ID (number)
  • policyId - Policy ID (number)
  • flagCount - Flag to indicate service type (boolean)
  • startDate - Start date for ranges (string)
  • endDate - End date for ranges (string)
  • limit - Results limit (string)
  • claimNumber - Claim number (string)
  • policyNumber - Policy number (string)
  • salechannelId - Sales channel ID (string)

📞 Support

For any issues, please contact the API support team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

  • Documentation last updated: June 2025
  • API specialized in Visual Time and PostgreSQL operations
  • Main focus on policy issuance and banking insurance management
  • For further updates, refer to the API Exchange Portal

🚨 Important Considerations

  • ⚡ All endpoints require valid authentication
  • 🗄️ Multiple operations interact directly with PostgreSQL
  • ⏰ Several endpoints support date/time range queries
  • 🔄 The API handles both synchronous operations and reinjection processes
  • 📋 Support for different types of insurance products (life, general)

Reviews