cs-seguridad-social-sapi

(0 reviews)

This API provides access to social security services, allowing management of affiliations, contributions, employers, employees, benefits, health providers, and payments.

Welcome to the cs-seguridad-social-sapi documentation.
This API provides access to social security services, including the management of:

Affiliations
Contributions
Employers and Employees
Social Security Benefits
Health Providers
Payments

All services are exposed via versioned endpoints (e.g., v1) and offer secure integration with internal systems.

🌐 Base Information

API Title: cs-seguridad-social-sapi
Version: 1.0.0
Base URL: https://cs-seguridad-social-sapi-qa-v1.us-e1.cloudhub.io/api

🚀 Getting Started

Authentication: You must include the correct client_id and an OAuth 2.0 Bearer token to access secured endpoints.

Headers: Every request must include the following:

-H "client_id: YOUR_CLIENT_ID"
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Content-Type: For POST/PUT requests, use:
```
-H "Content-Type: application/json"
```

📍 Available Endpoints

📌 Endpoints Overview

🧾 Root Level Endpoints

Method	Endpoint	Description	Exchange Link
GET	`/transferable-employer`	Retrieves transferable employer data.	View details
GET	`/moratorium-period`	Retrieves information about moratorium periods.	View details
GET	`/transferable-business`	Lists businesses eligible for transfer.	View details
GET	`/business-structure`	Returns available business structure types.	View details

🏢 /health-service/employer Endpoints

Method	Endpoint	Description	Exchange Link
POST	`/health-service/employer/membership-Arl`	Submits ARL membership for an employer.	View details
POST	`/health-service/employer/retractionTransferOrEmployerAffiliationArl`	Retracts employer transfer or affiliation to ARL.	View details
POST	`/health-service/employer/beginningEmploymentRelationship`	Registers the start of an employment relationship.	View details
POST	`/health-service/employer/terminationEmploymentRelationship`	Ends an employment relationship.	View details

🏢 /health-service/headquarters Endpoints

Method	Endpoint	Description	Exchange Link
POST	`/health-service/headquarters/noveltyNotification`	Reports novelty events from headquarters.	View details

🏢 /health-service/workCenter Endpoints

Method	Endpoint	Description	Exchange Link
POST	`/health-service/workCenter/novelties`	Submits novelties for a work center.	View details
POST	`/health-service/workCenter/variationWorkCenterforDependentWorkersAndStudents`	Registers changes for work center of dependent workers and students.	View details

🏢 /health-service/arlEmployerTransfer Endpoints

Method	Endpoint	Description	Exchange Link
POST	`/health-service/arlEmployerTransfer/origin-ARL`	Registers employer ARL transfer origin.	View details
POST	`/health-service/arlEmployerTransfer/destination-ARL/transferNotification`	Notifies ARL transfer to destination.	View details

👤 /independentWorker Endpoints

Method	Endpoint	Description	Exchange Link
POST	`/independentWorker/affiliationIntoARL`	Registers independent worker ARL affiliation.	View details
POST	`/independentWorker/transferWorkersARLToAnother`	Transfers ARL membership to another ARL.	View details
POST	`/independentWorker/retractionOfARLMembership`	Retracts independent worker ARL membership.	View details
POST	`/independentWorker/retractionTransferOfARL`	Cancels ARL transfer request.	View details
POST	`/independentWorker/terminationMembershipOnARL`	Ends voluntary ARL membership.	View details
POST	`/independentWorker/reportingLatePayments-non-compliance`	Reports late payments or non-compliance.	View details
POST	`/independentWorker/suspensionOrActivationOfVoluntaryMembership`	Suspends or reactivates voluntary ARL membership.	View details
PUT	`/independentWorker/changeOccupationOrProfession`	Updates occupation or profession.	View details
PUT	`/independentWorker/correction-contributing-type-or-subtype`	Corrects contribution type or subtype.	View details
GET	`/independentWorker/checkActiveAffiliationIntoOccupationalRiskSystem`	Checks active ARL affiliations.	View details
GET	`/independentWorker/checkDetailsOfMembershipInformation`	Retrieves membership detail records.	View details
GET	`/independentWorker/arlTransferableWorkerConsultation`	Gets info about transferable workers.	View details
GET	`/independentWorker/queryOfDefaultPeriod`	Retrieves info about default periods.	View details

📤 Example Request (Generic)

curl -X POST "https://cs-seguridad-social-sapi-qa-v1.us-e1.cloudhub.io/api/v1/affiliations" \
-H "Content-Type: application/json" \
-H "client_id: YOUR_CLIENT_ID" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
  "employeeId": "123456789",
  "employerId": "987654321",
  "startDate": "2025-04-01"
}'

📊 Diagram

⚠️ 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
404 Not Found – Endpoint or resource not found
500 Internal Server Error – Unexpected error on the server

📞 Support

For any issues, please contact the API support team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

Documentation last updated: April 2025
For further updates, refer to the API Exchange Portal

home

🏠 Home - 🛡️cs-seguridad-social-sapi