cs-visual-time-sapi icon

cs-visual-time-sapi

(0 reviews)
System API that integrates with CS Visual Time to retrieve employee time records, enabling real-time tracking, reporting, and workforce management across environments

home

🏠 Home - 🧾 CS Visual Time SAPI

Welcome to the CS Visual Time SAPI documentation.

This API facilitates secure access to Visual Time Services, enabling operations related to insured individuals, policy management, document validation, accounting movements, and more. It supports integration for both individual and legal-person insurance processing.

  • Designed to offer smooth integration for insurance and client management operations with high security and scalability.

🌐 Base Information

  • API Title: CS Visual Time SAPI
  • Version: v1
  • Base URL: https://cs-visual-time-sapi-{env}-v1.us-e1.cloudhub.io/api/
  • Available Environments: dev, qa, prod

πŸš€ Getting Started

  1. Authentication: This API uses client_id and OAuth 2.0 Bearer token for authentication.
  2. Base URL: Use the provided Base URL (replace {env} with your target environment) as the prefix for all API endpoints.
  3. Headers: Include the following headers in each request:
client_id: YOUR_CLIENT_ID
Authorization: Bearer YOUR_ACCESS_TOKEN

πŸ”„ How to Consume

You can explore and test this API through the following platforms:


πŸ“ Available Endpoints

MethodEndpointDescriptionExchange Link
GET/insurances/generals/certificatesRetrieve general insurance certificates.View details
GET/insurances/card-protection/ratesFetch rates for card protection insurance.View details
GET/insurances/card-protection/quotesObtain quotes for card protection insurance.View details
GET/insurances/card-protection/issuing-of-policyIssue a policy for card protection insurance.View details
GET/insurances/life/issuing-of-policy-notifyNotify of issuing a life insurance policy.View details
GET/insurances/life/certificatesRetrieve life insurance certificates.View details
GET/insurances/earthquake/ratesFetch earthquake insurance rates.View details
GET/insurances/earthquake/quotesObtain quotes for earthquake insurance.View details
GET/insurances/earthquake/issuing-of-policyIssue a policy for earthquake insurance.View details
GET/insurances/quota-protection/ratesFetch quota protection insurance rates.View details
GET/insurances/quota-protection/quotesObtain quotes for quota protection insurance.View details
GET/insurances/quota-protection/issuing-of-policyIssue a policy for quota protection insurance.View details
GET/insurances/home/fire/ratesFetch home fire insurance rates.View details
GET/insurances/home/fire/quotesObtain quotes for home fire insurance.View details
GET/insurances/home/fire/issuing-of-policyIssue a policy for home fire insurance.View details
GET/participantsGet the list of participants.View details
GET/customersRetrieve customer data.View details
GET/billsGet the list of bills.View details
GET/bills/paymentsFetch payment details for bills.View details
GET/indemnitiesRetrieve indemnity details.View details
GET/documents-requiredGet the list of required documents for insurance policies.View details
GET/catalog/product/lifeRetrieve available life insurance products.View details
GET/retrieveClaimByPolicyRetrieve claim details based on a policy.View details
GET/retrievePolicyInformationFetch information related to an insurance policy.View details
GET/customers/legal-persons/insured/cancelCancel insured from legal-person customersView details
GET/customers/legal-persons/insured/migrationInclusion of insured individuals in institutional insuranceView details
GET/customers/individual/insuredRetrieve individual insured customers.View details
GET/insurability-casesGet the status of insurability cases.View details
GET/insurability-cases/statusRetrieve the status of specific insurability cases.View details
GET/insurances/life/ratesFetch rates for life insurance policies.View details
GET/insurances/life/quotesObtain quotes for life insurance.View details
GET/insurances/life/issuing-of-policyIssue a life insurance policy.View details
GET/insurances/life/certificatesRetrieve life insurance certificates.View details
GET/insurances/policy/life/cancelCancel life insurance policyView details
GET/insurances/policies-and-claim-incidentsGet policies and claim incidents.View details
GET/insurances/policiesRetrieve all policies.View details
GET/claimsFetch claim details.View details
GET/claims/attach-supportAttach supporting documents to claims.View details
GET/claims/creation-third-banking-informationAdd third-party banking information for claims.View details
GET/policiesRetrieve all insurance policies.View details
GET/v2/insurances/life/ratesFetch rates for life insurance (v2).View details
GET/catalog/product/Retrieve all insurance products.View details
GET/insurances-product-collectiveFetch collective insurance products.View details
GET/insurances-issuing-of-policy-product-collectiveIssue a collective insurance policy.View details
GET/obtain-policy-obObtain the policy OB (Operating Balance).View details
POST/insuredsInsert insured individuals in VT (Quoting Salesforce)View details
POST/reserve-policy-numberReserve master policy number - MuleView details
POST/create-policyCreate master policy in VTView details
POST/validate-restrictive-listsValidate restrictive lists - InspektorView details
POST/create-receiptCreate receipt and accounting entry in VTView details
POST/create-accounting-movementCreate accounting entryView details
POST/confirm-collectionConfirm successful collectionView details
POST/notify-client-creationNotify client creation resultView details
POST/request-document-validationRequest document validationView details
GET/get-documentsGet documents to verifyView details
POST/document-validation-resultDocument validation resultView details
POST/generate-payment-linkGenerate payment linkView details

πŸ“€ Example Request (Generic)

curl -X POST "https://cs-visual-time-sapi-qa-v1.us-e1.cloudhub.io/api/insureds" \
-H "client_id: YOUR_CLIENT_ID" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "insured_id": "12345",
  "insured_name": "John Doe",
  "insurance_type": "Life",
  "policy_number": "POL123456"
}'

⚠️ Error Handling

Standard HTTP status codes are used for error handling:

  • 200 OK – Request was successful
  • 400 Bad Request – Missing or invalid parameters
  • 401 Unauthorized – Authentication failed
  • 403 Forbidden – Access denied
  • 404 Not Found – Resource not found
  • 429 Too Many Requests – Rate limit exceeded
  • 500 Internal Server Error – Unexpected server error

πŸ“ž Support

For questions, issues, or integration support, please contact:

Integration Services and Applications Coordination

πŸ“§ epalma@fgs.co


πŸ“… Notes


Reviews