cs-visual-time-sapi
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
- Authentication: This API uses
client_id
andOAuth 2.0
Bearer token for authentication. - Base URL: Use the provided Base URL (replace
{env}
with your target environment) as the prefix for all API endpoints. - 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
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
GET | /insurances/generals/certificates | Retrieve general insurance certificates. | View details |
GET | /insurances/card-protection/rates | Fetch rates for card protection insurance. | View details |
GET | /insurances/card-protection/quotes | Obtain quotes for card protection insurance. | View details |
GET | /insurances/card-protection/issuing-of-policy | Issue a policy for card protection insurance. | View details |
GET | /insurances/life/issuing-of-policy-notify | Notify of issuing a life insurance policy. | View details |
GET | /insurances/life/certificates | Retrieve life insurance certificates. | View details |
GET | /insurances/earthquake/rates | Fetch earthquake insurance rates. | View details |
GET | /insurances/earthquake/quotes | Obtain quotes for earthquake insurance. | View details |
GET | /insurances/earthquake/issuing-of-policy | Issue a policy for earthquake insurance. | View details |
GET | /insurances/quota-protection/rates | Fetch quota protection insurance rates. | View details |
GET | /insurances/quota-protection/quotes | Obtain quotes for quota protection insurance. | View details |
GET | /insurances/quota-protection/issuing-of-policy | Issue a policy for quota protection insurance. | View details |
GET | /insurances/home/fire/rates | Fetch home fire insurance rates. | View details |
GET | /insurances/home/fire/quotes | Obtain quotes for home fire insurance. | View details |
GET | /insurances/home/fire/issuing-of-policy | Issue a policy for home fire insurance. | View details |
GET | /participants | Get the list of participants. | View details |
GET | /customers | Retrieve customer data. | View details |
GET | /bills | Get the list of bills. | View details |
GET | /bills/payments | Fetch payment details for bills. | View details |
GET | /indemnities | Retrieve indemnity details. | View details |
GET | /documents-required | Get the list of required documents for insurance policies. | View details |
GET | /catalog/product/life | Retrieve available life insurance products. | View details |
GET | /retrieveClaimByPolicy | Retrieve claim details based on a policy. | View details |
GET | /retrievePolicyInformation | Fetch information related to an insurance policy. | View details |
GET | /customers/legal-persons/insured/cancel | Cancel insured from legal-person customers | View details |
GET | /customers/legal-persons/insured/migration | Inclusion of insured individuals in institutional insurance | View details |
GET | /customers/individual/insured | Retrieve individual insured customers. | View details |
GET | /insurability-cases | Get the status of insurability cases. | View details |
GET | /insurability-cases/status | Retrieve the status of specific insurability cases. | View details |
GET | /insurances/life/rates | Fetch rates for life insurance policies. | View details |
GET | /insurances/life/quotes | Obtain quotes for life insurance. | View details |
GET | /insurances/life/issuing-of-policy | Issue a life insurance policy. | View details |
GET | /insurances/life/certificates | Retrieve life insurance certificates. | View details |
GET | /insurances/policy/life/cancel | Cancel life insurance policy | View details |
GET | /insurances/policies-and-claim-incidents | Get policies and claim incidents. | View details |
GET | /insurances/policies | Retrieve all policies. | View details |
GET | /claims | Fetch claim details. | View details |
GET | /claims/attach-support | Attach supporting documents to claims. | View details |
GET | /claims/creation-third-banking-information | Add third-party banking information for claims. | View details |
GET | /policies | Retrieve all insurance policies. | View details |
GET | /v2/insurances/life/rates | Fetch rates for life insurance (v2). | View details |
GET | /catalog/product/ | Retrieve all insurance products. | View details |
GET | /insurances-product-collective | Fetch collective insurance products. | View details |
GET | /insurances-issuing-of-policy-product-collective | Issue a collective insurance policy. | View details |
GET | /obtain-policy-ob | Obtain the policy OB (Operating Balance). | View details |
POST | /insureds | Insert insured individuals in VT (Quoting Salesforce) | View details |
POST | /reserve-policy-number | Reserve master policy number - Mule | View details |
POST | /create-policy | Create master policy in VT | View details |
POST | /validate-restrictive-lists | Validate restrictive lists - Inspektor | View details |
POST | /create-receipt | Create receipt and accounting entry in VT | View details |
POST | /create-accounting-movement | Create accounting entry | View details |
POST | /confirm-collection | Confirm successful collection | View details |
POST | /notify-client-creation | Notify client creation result | View details |
POST | /request-document-validation | Request document validation | View details |
GET | /get-documents | Get documents to verify | View details |
POST | /document-validation-result | Document validation result | View details |
POST | /generate-payment-link | Generate payment link | View 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 successful400 Bad Request
β Missing or invalid parameters401 Unauthorized
β Authentication failed403 Forbidden
β Access denied404 Not Found
β Resource not found429 Too Many Requests
β Rate limit exceeded500 Internal Server Error
β Unexpected server error
π Support
For questions, issues, or integration support, please contact:
Integration Services and Applications Coordination
π§ epalma@fgs.co
π Notes
- Documentation last updated: May 2025
- For further updates, refer to the API Exchange Portal