improved
v2.1.117
8 days ago by Guilherme Soares
Updated: GET /v2/eor/workers/compliance-documents/{document_id}/templates/download
Added updated_at parameter to response in order to show when document was last updated.
Endpoint:
Employee Agreement and Onboarding Tracking endpoints update
Improves Employee Agreement and Onboarding Tracking endpoints to allow for version validation during signature collection to avoid inconsistencies that could be caused by race condition.
Updated: POST /v2/eor/workers/contracts/:contract_id/signatures
- Add an optional version property to the payload in order to allow the client to specify the version of the Employment Agreement to be signed. In case of a mismatch, the API will return a 409 Conflict error. If the version either matches the internal version or is not provided, the endpoint will behave as before.
- Add a 409 Conflict error response to the response schema.
Endpoint: Sign a contract
Updated: GET /v2/eor/workers/contracts/:contract_id/employee-agreement/download
- Add an optional version query param to the endpoint in order to allow the client to specify the version of the Employment Agreement to be downloaded. We don't keep multiple Employment Agreements saved, so this version is for checking if the client has the correct version of the EA. In case of a mismatch, the API will return a 409 Conflict error. If the version either matches the internal version or is not provided, the endpoint will behave as before.
- Add a 409 Conflict error response to the response schema.
Endpoint: Download employee agreement PDF
Updated: GET /v2/onboarding/tracker/hris_profile/:hris_profile_id
- Add a employee_agreement object to the response schema, with the following properties:
- version_hash: Version of the Employment Agreement. Can be null if the EA has not yet been generated.
- status: Status of the Employment Agreement. Can be null if the EA has not yet been generated.
- The version_hash can be used to check if the client has the correct version of the EA when downloading or signing it as mentioned in the previous endpoints.
Endpoint: Get onboarding details by employee HRIS profile ID
Updated: GET /v2/onboarding/tracker/:tracker_id
- Same changes as the previous onboarding endpoint.